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.



Back to top

Input Output Detail Controls Samples Change History Top Errors for GetOrderTransactions
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 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"?>
<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>
      <SKU> SKUType (string) </SKU>
      <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 Occurrence Meaning
Standard Input Fields   [Jump to call-specific fields]
DetailLevel DetailLevelCodeType Optional,
repeatable: [0..*]		 Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. For example, a particular detail level might cause the response to include buyer-related data in every result (e.g., for every Item), but no seller-related data. Specifying a detail level is like using a predefined attribute list in the SELECT clause of an SQL query. Use the DetailLevel element to specify the required detail level that the client application needs pertaining to the data components that are applicable to the request.

The DetailLevelCodeType defines the global list of available detail levels for all request types. Most request types support certain detail levels or none at all. If you pass a detail level that exists in the schema but that isn't valid for a particular request, eBay ignores it processes the request without it. For each request type, see the detail level tables in the Input/Output Reference to determine which detail levels are applicable and which elements are returned for each applicable detail level. (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 Optional,
repeatable: [0..*]		 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 Final Value Fee (FVF) in the response. For most listing types, the Final Value Fee is returned in Transaction.FinalValueFee. The Final Value Fee is returned on a transaction-by-transaction basis for FixedPriceItem and StoresFixedPrice listing types. For all other listing types, the Final Value Fee is returned when the listing status is Completed. This value is not returned if the auction ended with Buy It Now.

For Dutch Buy It Now listings, the Final Value Fee is returned on a transaction-by-transaction basis.

Note: As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated. eBay throws an error if you submit a Dutch item listing with AddItem or VerifyAddItem. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the Quantity value to 1.
ItemTransactionIDArray ItemTransactionIDArrayType Conditional An array of ItemTransactionIDs.
ItemTransactionIDArray
  .ItemTransactionID 		ItemTransactionIDType Conditional,
repeatable: [0..*]		 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 eBay Item ID of the listing associated with the transaction being retrieved.
Max length: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).
ItemTransactionIDArray
  .ItemTransactionID.SKU 		SKUType (string) Conditional The SKU that the seller defined for the listing associated with the transaction being retrieved.
Max length: 50.
ItemTransactionIDArray
  .ItemTransactionID
  .TransactionID 		string Conditional The ID of a transaction being retrieved.
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) Conditional,
repeatable: [0..*]		 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.

•   WorldOfGood

(in/out) The transaction was created on the WorldOfGood site.



Back to top

Input Output Detail Controls Samples Change History Top Errors for GetOrderTransactions
GetOrderTransactions Output

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

See also Samples.

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

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"?>
<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>
        <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled>
        <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 ... -->
      <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled>
      <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>
        <ExcludeShipToLocation> string </ExcludeShipToLocation>
        <!-- ... more ExcludeShipToLocation nodes here ... -->
        <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>
            <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled>
            <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>
            <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled>
            <LastTimeModified> dateTime </LastTimeModified>
            <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
            <PaymentMethodUsed> BuyerPaymentMethodCodeType </PaymentMethodUsed>
          </Status>
          <TransactionID> string </TransactionID>
          <TransactionPrice> AmountType (double) </TransactionPrice>
          <TransactionSiteID> SiteCodeType </TransactionSiteID>
          <Variation> VariationType 
            <SKU> SKUType (string) </SKU>
            <VariationSpecifics> NameValueListArrayType 
              <NameValueList> NameValueListType 
                <Name> string </Name>
                <Value> string </Value>
                <!-- ... more Value nodes here ... -->
              </NameValueList>
              <!-- ... more NameValueList nodes here ... -->
            </VariationSpecifics>
            <VariationTitle> string </VariationTitle>
            <VariationViewItemURL> anyURI </VariationViewItemURL>
          </Variation>
        </Transaction>
        <!-- ... more Transaction nodes here ... -->
      </TransactionArray>
    </Order>
    <!-- ... more Order nodes here ... -->
  </OrderArray>
</GetOrderTransactionsResponse>
Return Value Type Occurrence 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 Conditionally,
repeatable: [0..*]		 A list of application-level errors (if any) that occurred when eBay processed the request.

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

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   RequestError

(out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data.

•   SystemError

(out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
Errors.ErrorCode token Conditionally A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document.
Errors.ErrorParameters ErrorParameterType Conditionally,
repeatable: [0..*]		 This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters
  [ attribute ParamID ]		 string Conditionally 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 Always,
repeatable: [1..*]		 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
  .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.

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 Conditionally,
repeatable: [0..*]		 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.

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

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

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 Always,
repeatable: [1..*]		 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.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingAddress.CityName 		string Conditionally The name of the user's city. Also applicable to Half.com (for GetOrders).
Max length: 64.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingAddress.Country 		CountryCodeType Conditionally The country code of the user.

If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made.

Also applicable to Half.com (for GetOrders).

Applicable values: See Country.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingAddress.CountryName 		string Conditionally The name of the user's country. Also applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingAddress
  .ExternalAddressID 		string Conditionally ID assigned to the address by the owner of the address (fitting only if the address is owned by PayPal; see AddressOwner). Also applicable to Half.com (for GetOrders).
Max length: 20.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingAddress.Name 		string Conditionally User's name for the address. Also applicable to Half.com (for GetOrders).
Max length: 64.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .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. Also applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingAddress.PostalCode 		string Conditionally User's postal code.

If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made.

Also applicable to Half.com (for GetOrders).
Max length: 12.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingAddress
  .StateOrProvince 		string Conditionally The region of the user's address. Also applicable to Half.com (for GetOrders).
Max length: 64.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingAddress.Street1 		string Conditionally Line 1 of the user's street address. Also applicable to Half.com (for GetOrders).
Max length: 100.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingAddress.Street2 		string Conditionally Line 2 of the user's address (such as an apartment number). Returned if the user specified a second street value for their address. Also applicable to Half.com (for GetOrders).
In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable).
Max length: 100.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingDetails 		ShippingDetailsType Always The shipping-related details for an item or transaction, including flat or calculated shipping costs and shipping insurance costs. Also applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingDetails
  .AllowPaymentEdit 		boolean Conditionally Instead of using this tag, see the PaymentEdited tag. Originally, the AllowPaymentEdit tag specified whether the seller allows the buyer to edit the payment amount for the transaction. (Sellers enabled this property in their My eBay user preferences on the eBay site.) ShippingDetails.AllowPaymentEdit is no longer being populated by calls to GetItemTransactions.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingDetails
  .ChangePaymentInstructions 		boolean Conditionally Whether the seller specified payment and shipping instructions during checkout (for example, to update the details of a transaction). Flat and calculated shipping.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingDetails.CODCost 		AmountType (double) Conditionally Valid only for the Italy site (site ID 101); contains the cash-on-delivery (COD) cost for COD shipping.

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

See Specifying the Cash on Delivery Option in Shipping Details.
OrderArray.Order
  .ShippingDetails
  .ExcludeShipToLocation 		string Conditionally,
repeatable: [0..*]		 This field works in conjunction with Item.ShipToLocations and specifies an international country or region to where you will not ship the associated item. On input, repeat this element for each location that you want to exclude as a shipping destination for the associated item. As output, this field is repeated for each location to where you will not ship.

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.

You can specify a default set of locations to where you will not ship items 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 specify any location with this field on input, 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.

To see the valid exclude ship-to locations for a specified site, call GeteBayDetails with DetailName set to ExcludeShippingLocationDetails. You can repeat this call for each site on which you list. The location values are eBay regions and countries. Note that 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 specify both regions and countries that you wish to exclude from your shipping destinations.

Note: To enable the display of your excluded ship-to locations in your item listings, 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
OrderArray.Order
  .ShippingDetails.GetItFast 		boolean Always Indicates whether the seller has opted the listing into the Get It Fast feature. If GetItFast is true and if at least one of the domestic shipping services offered by the seller is an expedited shipping service, every shipping service offered by the seller is considered a Get It Fast service, and the seller commits to delivering the item to the buyer-selected shipping service within one day.

Applicable to Half.com for GetOrders.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingDetails.InsuranceFee 		AmountType (double) Always Cost of shipping insurance set by the seller. If the buyer bought more than one of this item, this is the insurance for just a single item. Exception: for GetItemShipping, this is proportional to QuantitySold. Value should be greater than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. Optional as input and only allowed if ChangePaymentInstructions is true. This field is ignored when InsuranceOption is not specified in the request.

Valid only on the following sites: AU, FR, and IT
Applicable to Half.com for GetOrders.
Default: 0.00.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingDetails
  .InsuranceOption 		InsuranceOptionCodeType Always Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Optional as input and only allowed if ChangePaymentInstructions is true. If this field is not included in the request, values specified in the InsuranceFee field will be ignored.

Note: Note that sellers are responsible for the items they sell until they safely arrive in their customers' hands, and that offering buyer-paid insurance (either as an optional or required service) infers that the buyer is somehow responsible for the safe delivery of the items they purchase. This notion can reduce buyer confidence in the marketplace and the practice of including buyer- paid shipping insurance in your item listings is discouraged.
This field is always returned with a request version lower than 635. With a request version of 635 or higher, this field is only returned if the value is other than NotOffered.

Valid only on the following sites: AU, FR, and IT
If you include buyer-paid shipping insurance for an item listed on one of the sites that supports this option, a buyer on a site that does not support buyer-paid shipping insurance can still purchase the item. In these cases, the buyer is responsible for all the shipping insurance terms that have been outlined in the item listing.

Applicable to Half.com

Applicable values:

•   CustomCode

(in/out) Reserved for internal or future use

•   IncludedInShippingHandling

(in/out) The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost.

•   NotOffered

(in/out) The seller does not offer shipping insurance to the buyer.

•   NotOfferedOnSite

(out) Shipping insurance is not offered as a separate option on the site where the item is listed. (Some shipping services, such as DE_InsuredExpressOrCourier, include insurance as part of the service.) If another insurance option is specified in the listing request and the site does not support shipping insurance as a separate option, eBay will reset the insurance option to this value. At the time of this writing, this option is only meaningful for the eBay Germany, Austria, and Switzerland sites.

•   Optional

(in/out) The seller offers the buyer the choice of paying for shipping insurance or not.

•   Required

(in/out) The seller requires that the buyer pay for shipping insurance.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingDetails
  .InsuranceWanted 		boolean Always 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: AU, FR, and IT
Applicable to Half.com for GetOrders.

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

If you specify ShippingDetails when you revise or relist an item but you omit InternationalShippingServiceOption, eBay will drop the international 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 three domestic shipping services and up to three international shipping services. All domestic services must be the same shipping type (for example, Flat versus Calculated); the same is true for international shipping services offered by the seller.

Not applicable to Half.com or eBay Motors vehicle listings.

DetailLevel: ItemReturnDescription, 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).
OrderArray.Order
  .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
Also applicable to Half.com (for GetOrders).

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

See Shipping.
OrderArray.Order
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingInsuranceCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Currency in which the monetary amount is specified.

In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingService 		token Conditionally An international shipping service offered for shipping the item. For a list of valid values that you can cache for future use, call GeteBayDetails with DetailName set to ShippingServiceDetails. For flat and calculated shipping.

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

See GeteBayDetails.



Applicable values: See ShippingServiceCodeType
OrderArray.Order
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceAdditionalCost 		AmountType (double) Conditionally Cost of shipping each additional item beyond the first item. Should be zero for single-item listings. Default value is 0.00. For flat shipping only.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Currency in which the monetary amount is specified.

In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceCost 		AmountType (double) Conditionally The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.

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

See Shipping.
OrderArray.Order
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Currency in which the monetary amount is specified.

In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServicePriority 		int Conditionally Seller-preferred presentation order relative to other service options. Valid values are: 1, 2 and 3 (first, second and third choices). For flat and calculated shipping.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShipToLocation 		string Conditionally,
repeatable: [0..*]		 An international location or region to where the item seller will ship the item. Use GeteBayDetails to determine which locations are valid per site. These values are string equivalents of values found in ShippingRegionCodeType and CountryCodeType. For the AddItem family of calls, this field is required if any international shipping service is specified.

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

See ShipToLocation.



Applicable values: See CountryCodeType, ShippingRegionCodeType
OrderArray.Order
  .ShippingDetails.SalesTax 		SalesTaxType Always Sales tax details. US site only. Flat and calculated shipping.

Not applicable to eBay Motors vehicle listings.
Applicable to Half.com (for GetOrders).

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

See Enabling Multi-jurisdiction Sales Tax.
OrderArray.Order
  .ShippingDetails.SalesTax
  .SalesTaxAmount 		AmountType (double) Always (US only) The amount of sales tax, calculated for a transaction based on the SalesTaxPercent and pricing information.

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 ItemID and TransactionID to call GetOrderTransactions.

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingDetails.SalesTax
  .SalesTaxPercent 		float Always Percent of an item's price to be charged as the sales tax for the transaction. The value passed in is stored with a precision of 3 digits after the decimal point (##.###).

Applicable to Half.com (for GetOrders).

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

Applicable to Half.com (for GetOrders).

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

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingDetails
  .SellingManagerSalesRecordNumber 		int Conditionally The sale record ID. Applicable to Selling Manager users. When an item is sold, Selling Manager generates a sale record. A sale record contains buyer information, shipping, and other information. A sale record is displayed in the Sold view in Selling Manager. Each sale record has a sale record ID. In the following calls, the value for the sale record ID is in the SellingManagerSalesRecordNumber field: GetItemTransactions, GetSellerTransactions, GetOrders, GetOrderTransactions. In the Selling Manager calls, the value for the sale record ID is in the SaleRecordID field. The sale record ID can be for one transaction or for an order (which contains multiple transactions).
Applicable to Half.com (for GetOrders).

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

...
...
...
...
...

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 three domestic shipping services and up to three international shipping services. All domestic services must be the same shipping type (for example, Flat versus Calculated); the same is true for international shipping services offered by the seller.

Not applicable to Half.com or eBay Motors vehicle listings.

DetailLevel: ItemReturnDescription, 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).
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ExpeditedService 		boolean Conditionally Indicates whether the service is an expedited shipping service. See Enabling Get It Fast. Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .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. Also applicable to Half.com (for GetOrders).

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

See Determining Shipping Costs for a Listing.
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingInsuranceCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Currency in which the monetary amount is specified.

In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingService 		token Conditionally A domestic shipping service offered for shipping the item (for example, UPS Ground). For a list of valid values that you can cache for future use, call GeteBayDetails with DetailName set to ShippingServiceDetails. For flat and calculated shipping. Also applicable to Half.com (for GetOrders).

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

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

See GeteBayDetails.



Applicable values: See ShippingServiceCodeType
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceAdditionalCost 		AmountType (double) Conditionally The cost of shipping each additional item beyond the first item. For input, this is required if the listing is for multiple items and should be zero for single-item listings. Default value is 0.00. For flat shipping only. Not applicable to Half.com.

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

See Determining Shipping Costs for a Listing.
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Currency in which the monetary amount is specified.

In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost 		AmountType (double) Conditionally The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.

Also applicable to Half.com (for GetOrders).

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

See Determining Shipping Costs for a Listing.
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Currency in which the monetary amount is specified.

In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServicePriority 		int Conditionally Seller-preferred presentation order relative to other service options. Valid values: 1 (1st choice), 2 (2nd choice), 3 (3rd choice). For flat and calculated shipping. Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingSurcharge 		AmountType (double) Conditionally An additional fee to charge US buyers who ship via UPS 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 transactions in an order have a surcharge, surcharge is added only for those transactions. Flat rate shipping only.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingSurcharge
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Currency in which the monetary amount is specified.

In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingDetails.TaxTable 		TaxTableType Conditionally Tax details for a jurisdiction, such as a state or province. If no tax table is associated with the item, a tax table is not returned.

For GetItem, a tax table is returned if it exists when:
- DetailLevel is set to ReturnAll or ItemReturnDescription (in this case, the value of IncludeTaxTable does not matter).
- IncludeTaxTable is set to true and DetailLevel is not set or it is set to ItemReturnAttributes.

Not applicable to Half.com.

DetailLevel: ReturnAll.
OrderArray.Order
  .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: ReturnAll.
OrderArray.Order
  .ShippingDetails.TaxTable
  .TaxJurisdiction
  .JurisdictionID 		string Conditionally Representative identifier for the jurisdiction. Typically an abbreviation (for example, CA for California).

DetailLevel: ReturnAll.
OrderArray.Order
  .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: ReturnAll.
OrderArray.Order
  .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: ReturnAll.
OrderArray.Order
  .ShippingServiceSelected 		ShippingServiceOptionsType Always The shipping service selected by the buyer from the services offered by the seller. Also applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingServiceSelected
  .ExpeditedService 		boolean Conditionally Indicates whether the service is an expedited shipping service. See Enabling Get It Fast. Not applicable to Half.com.

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

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

See Determining Shipping Costs for a Listing.
OrderArray.Order
  .ShippingServiceSelected
  .ShippingInsuranceCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Currency in which the monetary amount is specified.

In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingServiceSelected
  .ShippingService 		token Conditionally A domestic shipping service offered for shipping the item (for example, UPS Ground). For a list of valid values that you can cache for future use, call GeteBayDetails with DetailName set to ShippingServiceDetails. For flat and calculated shipping. Also applicable to Half.com (for GetOrders).

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

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

See GeteBayDetails.



Applicable values: See ShippingServiceCodeType
OrderArray.Order
  .ShippingServiceSelected
  .ShippingServiceAdditionalCost 		AmountType (double) Conditionally The cost of shipping each additional item beyond the first item. For input, this is required if the listing is for multiple items and should be zero for single-item listings. Default value is 0.00. For flat shipping only. Not applicable to Half.com.

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

See Determining Shipping Costs for a Listing.
OrderArray.Order
  .ShippingServiceSelected
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Currency in which the monetary amount is specified.

In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingServiceSelected
  .ShippingServiceCost 		AmountType (double) Conditionally The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.

Also applicable to Half.com (for GetOrders).

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

See Determining Shipping Costs for a Listing.
OrderArray.Order
  .ShippingServiceSelected
  .ShippingServiceCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Currency in which the monetary amount is specified.

In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingServiceSelected
  .ShippingServicePriority 		int Conditionally Seller-preferred presentation order relative to other service options. Valid values: 1 (1st choice), 2 (2nd choice), 3 (3rd choice). For flat and calculated shipping. Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingServiceSelected
  .ShippingSurcharge 		AmountType (double) Conditionally An additional fee to charge US buyers who ship via UPS 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 transactions in an order have a surcharge, surcharge is added only for those transactions. Flat rate shipping only.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingServiceSelected
  .ShippingSurcharge
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Currency in which the monetary amount is specified.

In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order.Subtotal AmountType (double) Always The sum of the sale prices of all of the transactions in the order, where a transaction sale price is the item sale price times the quantity sold. Also applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.Total AmountType (double) Always Subtotal plus the shipping cost plus the sales tax plus cost of insurance. Also applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray 		TransactionArrayType Always The set of two or more transactions that make up the order. Also applicable to Half.com (for GetOrders).

We strongly recommend that you avoid mixing transactions for digital and non-digital listings in the same order. (In the future, AddOrder may enforce this recommendation.)

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction 		TransactionType Always,
repeatable: [1..*]		 Information about one transaction. Also applicable to Half.com (for GetOrders).

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

See Working with Combined Payment.
OrderArray.Order
  .TransactionArray.Transaction
  .AdjustmentAmount 		AmountType (double) Conditionally Adjustment amount entered by the buyer. A positive amount indicates the amount is an extra charge being paid to the seller by the buyer. A negative value indicates this amount is a credit given to the buyer by the seller.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .AmountPaid 		AmountType (double) Conditionally The amount the buyer paid for the item(s) in the transaction. If the seller allowed the buyer to change the item total, the buyer is able to change the total until the time that the transaction's status moves to Complete. Determine whether the buyer changed the amount by retrieving the transaction data and comparing the AmountPaid value to what the seller expected. For combined payment (the transaction is part of an order), GetSellerTransactions and GetItemTransactions return the amount paid for the order to which the transaction belongs. For Motors items, AmountPaid is the amount paid by the buyer for the deposit.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .BestOfferSale 		boolean Conditionally Whether the transaction was completed with the seller selecting a best offer.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer 		UserType Conditionally Contains the data for the transaction's buyer. See UserType for its child elements. Returned by GetItemsAwaitingFeedback if Seller is making the request.

Applicable to Half.com (for GetOrders only).

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

DetailLevel: ReturnAll.
OrderArray.Order
  .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.

See Working with Anonymous User Information.
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress 		AddressType Conditionally Contains the address of the buyer in the transaction, to which the seller would ship the item(s). See AddressType for its child elements. GetAllBidders is returning only Country and PostalCode currently. Output only.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer.BuyerInfo
  .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
  .TransactionArray.Transaction
  .Buyer.BuyerInfo
  .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.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress.CityName 		string Conditionally The name of the user's city. Also applicable to Half.com (for GetOrders).
Max length: 64.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress.Country 		CountryCodeType Conditionally The country code of the user.

If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made.

Also applicable to Half.com (for GetOrders).

Applicable values: See Country.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress.CountryName 		string Conditionally The name of the user's country. Also applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress
  .ExternalAddressID 		string Conditionally ID assigned to the address by the owner of the address (fitting only if the address is owned by PayPal; see AddressOwner). Also applicable to Half.com (for GetOrders).
Max length: 20.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress.Name 		string Conditionally User's name for the address. Also applicable to Half.com (for GetOrders).
Max length: 64.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .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. Also applicable to Half.com (for GetOrders).

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

If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made.

Also applicable to Half.com (for GetOrders).
Max length: 12.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress
  .StateOrProvince 		string Conditionally The region of the user's address. Also applicable to Half.com (for GetOrders).
Max length: 64.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress.Street1 		string Conditionally Line 1 of the user's street address. Also applicable to Half.com (for GetOrders).
Max length: 100.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress.Street2 		string Conditionally Line 2 of the user's address (such as an apartment number). Returned if the user specified a second street value for their address. Also applicable to Half.com (for GetOrders).
In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable).
Max length: 100.

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

DetailLevel: ReturnAll.
OrderArray.Order
  .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.

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.

See Working with Anonymous User Information.
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer.Email 		string Conditionally Email address for the user. You cannot retrieve an email address for any user with whom you do not have a transactional relationship, regardless of site. Email is only returned for applicable calls when you are retrieving your own user data OR when you and the other user are in a transactional relationship and the call is being executed within a certain amount of time after the transaction is created. 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.

DetailLevel: ReturnAll.

See Working with Anonymous User Information.
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer.FeedbackPrivate 		boolean Conditionally Indicates whether the user has chosen to make their feedback score and feedback details private (hidden from other users). Note that the percentage of positive feedback can still be returned, even if other feedback details are private. In GetSearchResults and GetCategoryListings, feedback information is only returned if IncludeFeedback = true in the request.

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.

See Working with Anonymous User Information.
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer.FeedbackRatingStar 		FeedbackRatingStarCodeType Conditionally Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for specific values.

Applicable values:

•   Blue

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

•   CustomCode

(out) Reserved for internal or future use.

•   Green

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

•   GreenShooting

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

•   None

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

•   Purple

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

•   PurpleShooting

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

•   Red

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

•   RedShooting

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

•   SilverShooting

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

•   Turquoise

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

•   TurquoiseShooting

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

•   Yellow

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

•   YellowShooting

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




DetailLevel: ReturnAll.
OrderArray.Order
  .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 transactions. Each transaction 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 GetSearchResults and GetCategoryListings, feedback information is only returned if IncludeFeedback = true in the request.
In GetMyeBayBuying and GetMyeBaySelling, feedback information (FeedbackScore and FeedbackRatingStar) is returned in BidList.ItemArray.Item.Seller. For GetMyeBayBuying, the feedback score of each seller with an item having received a bid from the buyer is returned. For GetMyeBaySelling, the feedback score of the seller is returned.

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

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

DetailLevel: ReturnAll.

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

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

DetailLevel: ReturnAll.
OrderArray.Order
  .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.

See Working with Anonymous User Information.
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer.Site 		SiteCodeType Conditionally eBay site the user is registered with.

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

Applicable values: See Site.

DetailLevel: ReturnAll.

See Working with Anonymous User Information.
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer.Status 		UserStatusCodeType Conditionally Indicates the user's registration/user status.

Applicable values:

•   AccountOnHold

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

•   Confirmed

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

•   CreditCardVerify

(out) User has completed registration and confirmation, but is pending a verification of credit card information

•   CreditCardVerifyHalfOptIn

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

•   CustomCode

(out) Reserved for internal or future use

•   Deleted

(out) Records for the specified user have been deleted

•   Ghost

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

•   Guest

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

•   InMaintenance

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

•   Merged

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

•   RegistrationCodeMailOut

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

•   Suspended

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

•   TermPending

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

•   Unconfirmed

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

•   UnconfirmedExpress

Deprecated as of version 579.
(out) Half.com User; user has completed the registration for Half.com and opted to automatically also be registered with eBay, but the registration confirmation is still pending
Deprecation version: 579. See also Deprecated Objects.

•   UnconfirmedHalfOptIn

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

•   Unknown

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


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


DetailLevel: ReturnAll.
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer.UserAnonymized 		boolean Conditionally Indicates whether or not the User container has been made anonymous. If true, some elements in the User container have either been removed, or had their values changed to remove identifying characteristics. If false, all expected elements are returned, and no values are changed.

Since a bidder's user info is anonymous, this tag is returned as false only to the bidder, and to the seller of an item that the user is bidding on. For all other users, this tag is returned as true.

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

See Working with Anonymous User Information.
OrderArray.Order
  .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 listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A".

Note that in this format, the anonymous bidder ID stays the same for every auction.

For GetMyeBayBuying only, when bidding on items listed on the US site: 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 UK and AU sites: 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 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".

Note that when IncludeFeedback is true in a GetSearchResults request, the response contains the seller's User ID. Please note that a seller's UserID is not anonymized.

For PlaceOffer, see also SellingStatus.HighBidder.

DetailLevel: ReturnAll.

See Working with Anonymous User Information.
OrderArray.Order
  .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.

See Working with Anonymous User Information.
OrderArray.Order
  .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.

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

Applicable values:

•   CustomCode

(out) Reserved for internal or future use

•   NoVATTax

(out) VAT is not applicable

•   VATExempt

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

•   VATTax

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




DetailLevel: ReturnAll.

See VAT-exempt Sellers.
OrderArray.Order
  .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.
OrderArray.Order
  .TransactionArray.Transaction
  .CartID 		string Conditionally Shopping cart identifier. Only returned for transactions made on Shopping.com using the Shopping.com shopping cart.
Max length: 10.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .ConvertedAdjustmentAmount 		AmountType (double) Conditionally Converted value of AdjustmentAmount in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .ConvertedAmountPaid 		AmountType (double) Conditionally Converted value of AmountPaid in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .ConvertedTransactionPrice 		AmountType (double) Conditionally Converted value of TransactionPrice in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .CreatedDate 		dateTime Always Indicates when the transaction was created. For fixed-price, Stores, and BIN items this indicates when the purchase (or BIN) occurred. For competitive-bid item listing types this indicates when listing ended, the winning bidder(s) determined, and the transaction created.

Applicable to Half.com (for GetOrders only).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .DepositType 		DepositTypeCodeType Conditionally Whether the seller requires a deposit for the vehicle. Only applicable to US eBay Motors listings. If item is not a Motors item, then this returns an empty value.

Not applicable to Half.com.

Applicable values:

•   None

(out) No deposit needed.

•   OtherMethod

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


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


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

See Specifying a Vehicle Deposit and Deposit Amount.
OrderArray.Order
  .TransactionArray.Transaction
  .ExternalTransaction 		ExternalTransactionType Conditionally,
repeatable: [0..*]		 A PayPal transaction that relates to this eBay transaction. Returned only if there is at least one PayPal transaction related to this eBay transaction.

Not applicable to Half.com.

DetailLevel: ReturnAll.
OrderArray.Order
  .TransactionArray.Transaction
  .ExternalTransaction
  .ExternalTransactionID 		string Conditionally Unique payment transaction ID.

DetailLevel: ReturnAll.
OrderArray.Order
  .TransactionArray.Transaction
  .ExternalTransaction
  .ExternalTransactionTime 		dateTime Conditionally Date on which transaction occurs.

DetailLevel: ReturnAll.
OrderArray.Order
  .TransactionArray.Transaction
  .ExternalTransaction
  .FeeOrCreditAmount 		AmountType (double) Conditionally

DetailLevel: ReturnAll.
OrderArray.Order
  .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.
OrderArray.Order
  .TransactionArray.Transaction
  .FinalValueFee 		AmountType (double) Conditionally You are charged a Final Value Fee (FVF) if your item is sold, ends with a winning bid, or is purchased. This fee applies whether or not you actually complete the sale with the buyer. The Final Value Fee is returned in Transaction.FinalValueFee. See the eBay.com Web site online help for more information about the Final Value Fee.

The Final Value Fee for fixed price format (FixedPriceItem) and Store Inventory (StoresFixedPrice) items is returned by GetSellerTransactions, GetItemTransactions, and GetOrderTransactions on a transaction-by-transaction basis, regardless of the listing status. For all other listing types, (excluding Buy It Now purchases), the Final Value Fee is returned when the listing status is Completed.

If you request a Final Value Fee Credit, the value of Transaction.FinalValueFee will not change for the item if a credit is issued. (The credit only appears in the seller's account data.)

Not applicable to Half.com.

If the item was a Dutch auction that ended with bids (not Buy It Now purchases), the Final Value Fee is returned on a transaction-by-transaction basis in Item.SellingStatus.FinalValueFee.

Note: As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated. eBay throws an error if you submit a Dutch item listing with AddItem or VerifyAddItem. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the Quantity value to 1.


DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Item 		ItemType Always Information about the item that spawned the transaction. It is a purchase from this item's listing that the transaction represents. To remove a property from an item, specify it in ModifyType as a changed property, but do not give it a value in Item.

Applicable to Half.com (for GetOrders).

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

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

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .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). If true, the seller must also accept PayPal as a payment method for the item (see Item.PaymentMethods).

See the eBay Web Services guide section on Immediate Payment for additional requirements and dependencies. Also see the section on working with the eBay Motors site for additional rules.

To create an Immediate Payment listing ThirdPartyCheckout must be true, AutoPay must be true, PayPalEmailAddress must be a valid PayPal email address for the seller, and PaymentMethods must be PayPal. For a non-Immediate Payment listing, if ThirdPartyCheckout is true, AutoPay is not supported.

Not applicable to Half.com.

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

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

OrderArray.Order
  .TransactionArray.Transaction
  .Item.BuyerProtection 		BuyerProtectionCodeType Always Indicates the status of the item's eligibility for the PayPal Buyer Protection program.

Not applicable to Half.com.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   ItemEligible

(out) Item is eligible per standard criteria.

•   ItemIneligible

(out) Item is ineligible (e.g., category not applicable).

•   ItemMarkedEligible

(out) Item marked eligible per other criteria.

•   ItemMarkedIneligible

(out) Item marked ineligible per special criteria (e.g., seller's account closed).

•   NoCoverage

(out) For the Australia site, indicates that there is no PayPal Buyer Protection coverage. Coverage details would be 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.

See Miscellaneous Item Field Differences.
OrderArray.Order
  .TransactionArray.Transaction
  .Item.BuyItNowPrice 		AmountType (double) Conditionally For Chinese auction listings, Buy It Now allows a user to purchase the item at a fixed price and end the auction immediately. Use this field to add Buy It Now and specify the amount a buyer would need to bid to take advantage of the Buy It Now feature.

On the main eBay site, not applicable to fixed-price items (ListingType values StoresFixedPrice or FixedPriceItem), AdFormat listings, or Half.com listings. For fixed-price and Half.com listings, see StartPrice instead. See the eBay Web Services Guide for validation rules when revising US eBay Motors listings, including rules for lowering the Buy It Now price of a Motors listing.

Once a Chinese auction has bids (and the high bid exceeds the reserve price, if specified), the listing is no longer eligible for Buy It Now (with some exceptions noted below). However, calls like GetItem and GetSearchResults still return the BuyItNowPrice that the seller originally set for the listing. You can use Item.SellingStatus.BidCount to determine whether an auction with Buy It Now has bids or not. With GetSearchResults, you can use the Item.SearchDetails.BuyItNowEnabled flag to determine whether the item can still be purchased using Buy It Now. With GetItem, you can use the Item.ListingDetails.BuyItNowAvailable flag to determine whether the item can still be purchased using Buy It Now.

On some sites, the Buy It Now price for a Chinese auction may remain available for certain categories even after a bid is placed. See the "Longer Lasting Buy It Now" link below for more details and the latest list of eBay US categories that support this behavior. The eBay Spain site supports this behavior for all categories.

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

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

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

See:
    Longer Lasting Buy It Now
    Revising US eBay Motors Listings

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

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

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

Not applicable to Half.com.

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

See:
    Miscellaneous Item Field Differences
    Identifying Listings that Benefit Nonprofits

OrderArray.Order
  .TransactionArray.Transaction
  .Item.Charity.CharityID 		string Conditionally A unique identification number assigned by eBay to registered nonprofit charity organizations. Required input when listing Giving Works items.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Item.Charity.CharityListing 		boolean Conditionally If true, indicates that the seller has chosen to use eBay Giving Works to donate a percentage of the item's purchase price to a selected nonprofit organization.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Item.Charity.CharityName 		string Conditionally The name of the benefiting nonprofit charity organization selected by the charity seller.
Max length: 150.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Item.Charity.CharityNumber 		int Conditionally A unique identification number assigned to a nonprofit charity organization by the dedicated provider of eBay Giving Works. Being superseded by CharityID. Max 10 digits.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Item.Charity.DonationPercent 		float Conditionally The percentage of the purchase price that the seller chooses to donate to the selected nonprofit organization. This percentage is displayed in the Giving Works item listing. Possible values: 10.0 to 100.0. Percentages must increment by 5.0. Minimum donation percentages may be required for Giving Works listings, see http://pages.ebay.com/help/sell/selling-nonprofit.html for details. DonationPercent is required input when listing Giving Works items.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Item.GetItFast 		boolean Conditionally Indicates whether the seller has opted the listing into the Get It Fast feature. If GetItFast is true and if at least one of the domestic shipping services offered by the seller is an expedited shipping service, every shipping service offered by the seller is considered a Get It Fast service, and the seller commits to delivering the item to the buyer-selected shipping service within one day.

Not supported for UK Store Inventory format items.
Not applicable to Half.com.

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

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

OrderArray.Order
  .TransactionArray.Transaction
  .Item
  .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. A payment gateway account is used by sellers to accept online credit cards (Visa, MasterCard, American Express, and Discover).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Item.ItemID 		ItemIDType (string) Always The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value.

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

In transaction calls (e.g., GetItemTransactions), use a combination of ItemID and TransactionID to uniquely identify a transaction. With multi-quantity listings, a single ItemID can be associated with more than one TransactionID. (For single-quantity listings, the TransactionID is 0.)

In GetItemRecommendations, the item ID is required when the value of ListingFlow is ReviseItem or RelistItem, but it is not applicable when the value of ListingFlow is AddItem.

In GetSearchResults, the same ItemID may be returned for multiple results if the results are variations from the same mult-variation listing.

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

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Item.ListingType 		ListingTypeCodeType Always The format of the listing the seller wants to use, such as Chinese auction or fixed price.

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

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

Applicable values:

•   AdType

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

•   Chinese

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

•   CustomCode

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

•   Dutch

Deprecated as of version 611.
(in/out) Multiple-quantity online auction format. A Dutch auction has a Quantity greater than 1. Buyers engage in competitive bidding. Some sites also offer Buy It Now for Dutch auctions. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner.

Note: As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated. eBay throws an error if you submit a Dutch item listing with AddItem or VerifyAddItem. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the Quantity value to 1.

Deprecation version: 611. See also Deprecated Objects.

•   Express

Deprecated as of version 561.
(in/out) For Germany only: eBay Express format (item is listed only on eBay Express only, not on eBay). You must be an Express Germany seller to use this format. See "Express Format Criteria" in the eBay Web Services guide. As of late April 2008, this value will no longer work, regardless of the API version you are using.
Deprecation version: 561. See also Deprecated Objects.

•   FixedPriceItem

(in/out) A basic fixed-price item format. Bids do not occur. The quantity of items is one or more. Also known as Buy It Now Only on some sites (not to be confused with the BuyItNow option that is available for Chinese auctions). Sellers must meet certain feedback requirements and/or be ID Verified to use this format. See Minimum Feedback Requirements for Various Features in the Trading Web Services guide. Fixed-price listings are listed on eBay.com, and they are listed in the seller's eBay Store if the seller is a Store owner. Stores fixed price items will be treated as basic fixed-price items. Permitted durations of 30 days and GTC are now available for store and non-store subscribers (in addition to the existing durations of 3, 5, 7, and 10 days). Use the GetCategoryFeatures call to determine if a particular site has adopted this method. The release notes will also contain much of this information.

•   LeadGeneration

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

•   Live

Deprecated as of version 601.
(out) Live auction, on-site auction that can include non-eBay bidders. (Use AddLiveAuctionItem to list live auctions.) Live auctions are listed on the eBay Live Auctions site, in live auction categories. They can also appear on eBay if the seller lists the lot in a secondary category that is an eBay category.
Deprecation version: 601. See also Deprecated Objects.

•   PersonalOffer

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

•   StoresFixedPrice

(in/out) A fixed-price format for eBay Store sellers. Store Inventory listings appear after other listings in regular browse and search item lists on eBay. They have a lower Insertion Fee and longer listing durations. Only available to sellers who have an eBay Store. Store Inventory listings are listed on eBay.com, and they are also listed in the seller's eBay Store. Stores fixed price items will be treated as basic fixed-price items; please see the documentation for FixedPriceItem (that is, for the basic fixed-price item format). Use the GetCategoryFeatures call to determine if a particular site has adopted this method. The release notes will also contain much of this information.


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


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

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

OrderArray.Order
  .TransactionArray.Transaction
  .Item.PrivateListing 		boolean Always If true, designates the listing as private. When you create a private listing, a buyer's User ID will not appear in the listing or in the listing's bid history. Sellers may want to use this option when they believe that potential bidders for a listing would not want their User IDs disclosed to others.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Item.SellingStatus 		SellingStatusType Always Various details about the current status of the listing, such as the current number of bids and the current high bidder.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Item.SellingStatus
  .ConvertedCurrentPrice 		AmountType (double) Conditionally Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites).

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

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Item.SellingStatus
  .CurrentPrice 		AmountType (double) Conditionally For competitive-bid item listings (Chinese auctions), current minimum asking price (start price) or the current highest bid for the item if bids have been placed. Shows minimum bid if no bids have been placed on the item. For Basic Fixed-Price (FixedPriceItem), Store Inventory (StoresFixedPrice), or Ad type (AdType) listings this returns the original price specified when the item was listed/re-listed or the revised price if the item was revised using the ReviseItem call.

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.
OrderArray.Order
  .TransactionArray.Transaction
  .Item.SellingStatus
  .FinalValueFee 		AmountType (double) Conditionally You are charged a Final Value Fee (FVF) if your item is sold, ends with a winning bid, or is purchased. This fee applies whether or not you actually complete the sale with the buyer. The Final Value Fee is returned in Transaction.FinalValueFee. See the eBay.com Web site online help for more information about the final value fee.

The Final Value Fee for fixed price format (FixedPriceItem) and Store Inventory (StoresFixedPrice) items is returned by GetSellerTransactions, GetItemTransactions, and GetOrderTransactions on a transaction-by-transaction basis, regardless of the listing status. For all other listing types, (excluding Buy It Now purchases), the Final Value Fee is returned when the listing status is Completed.

If you request a Final Value Fee Credit, the value of Transaction.FinalValueFee will not change for the item if a credit is issued. (The credit only appears in the seller's account data.)

If the item was a Dutch auction that ended with bids (not Buy It Now purchases), the Final Value Fee is returned on a transaction-by-transaction basis in Item.SellingStatus.FinalValueFee.

Note: As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated. eBay throws an error if you submit a Dutch item listing with AddItem or VerifyAddItem. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the Quantity value to 1.


DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Item.SellingStatus
  .ListingStatus 		ListingStatusCodeType Conditionally 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.

Dutch (multi-listing) Buy It Now auctions are Completed on a transaction-by-transaction basis, and the Final Value Fee is returned by GetSellerTransactions and GetItemTransactions.

Note: As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated. eBay throws an error if you submit a Dutch item listing with AddItem or VerifyAddItem. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the Quantity value to 1.

•   Custom

(out) Reserved for internal or future use.

•   CustomCode

(out) Reserved for internal or future use.

•   Ended

(out) The listing has ended. If the listing ended with a sale, eBay has completed processing of the sale. All sale information returned from eBay (e.g., total price and high bidder) should be considered accurate and complete. However, the final value fee is not yet available.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .PayPalEmailAddress 		string Conditionally The seller's Paypal email address.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Platform 		TransactionPlatformCodeType Always Name of the eBay co-branded site upon which the transaction was made.

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.

•   WorldOfGood

(in/out) The transaction was created on the WorldOfGood site.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .QuantityPurchased 		int Conditionally Indicates the number of items the buyer purchased from the listing identified in ItemID.

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .SellerContactBuyerByEmail 		boolean Conditionally Indicates whether the buyer has opted to accept emails from all the seller(s) in the Shopping.com shopping cart. Only returned for transactions made on Shopping.com using the Shopping.com shopping cart.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Status 		TransactionStatusType Conditionally Contains the status of the transaction, such as the buyer's online payment and whether the checkout process for the transaction has been completed. See TransactionStatusType for its child elements.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .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.
OrderArray.Order
  .TransactionArray.Transaction
  .Status.CheckoutStatus 		CheckoutStatusCodeType Conditionally Indicates the current status of the checkout process for the transaction.

Applicable values:

•   BuyerRequestsTotal

(out) Buyer requests total from seller.

•   CheckoutComplete

(out) Checkout complete.

•   CheckoutIncomplete

(out) Checkout incomplete--no details specified.

•   CustomCode

(out) Reserved for future use.

•   SellerResponded

(out) Seller responded to buyer's request.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Status.CompleteStatus 		CompleteStatusCodeType Conditionally Indicates whether the transaction process is complete or incomplete.

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
  .TransactionArray.Transaction
  .Status.eBayPaymentStatus 		PaymentStatusCodeType Conditionally Indicates the success or failure of the buyer's online payment for a transaction. Applicable for the payment method that the buyer chose for the transaction. If the payment failed, the value returned indicates the reason for the failure. Output only.

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
  .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.
OrderArray.Order
  .TransactionArray.Transaction
  .Status.LastTimeModified 		dateTime Conditionally Indicates date and time a transaction's status or incomplete state was last updated (in GMT).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Status.PaymentHoldStatus 		PaymentHoldStatusCodeType Conditionally Contains the current status of a hold on a PayPal payment. The payment hold that is referred to as a "payment review" hold results from a possible issue with a buyer. The payment hold referred to as a "merchant hold" results from a possible issue with a seller. For more information, please see the link below. Additionally, in the cases of the GetMyeBaySelling and GetMyeBayBuying calls, the PaymentHoldStatus value can affect the value returned in in SellerPaidStatus and BuyerPaidStatus; see the PaymentHoldStatus applicable values.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   MerchantHold

(out) The payment hold referred to as a "merchant hold" results from a possible issue with a seller. If this value is returned, then the following values, as a result, will be returned: In GetMyeBaySelling, PaidWithPayPal is returned in TransactionArray.Transaction.SellerPaidStatus. In GetMyeBayBuying, PaidWithPayPal is returned in TransactionArray.Transaction.BuyerPaidStatus.

•   None

(out) Indicates that there is no payment review hold and no merchant hold.

•   PaymentReview

(out) The payment hold referred to as a "payment review" hold results from a possible issue with a buyer. If this value is returned, then the following values, as a result, will be returned: In GetMyeBaySelling, NotPaid is returned in TransactionArray.Transaction.SellerPaidStatus. In GetMyeBayBuying, PaidWithPayPal is returned in TransactionArray.Transaction.BuyerPaidStatus.

•   Released

(out) Indicates that a payment hold has been released.




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

See Holds on PayPal Payments.
OrderArray.Order
  .TransactionArray.Transaction
  .Status.PaymentMethodUsed 		BuyerPaymentMethodCodeType Conditionally Payment method the buyer selected for paying the seller for the transaction. If checkout is not yet complete, PaymentMethodUsed is set to whatever the buyer selected as his or her preference on the Review Your Purchase page.

Applicable values: See PaymentMethodUsed.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .TransactionID 		string Always Identifier for the transaction. A value of zero is used for the Chinese auction format. Thus, a value of zero is a valid transaction ID. A transaction ID is only unique to the listing that spawned it, so a transaction is only uniquely identified on a global basis by a combination of ItemID and TransactionID.

Applicable to Half.com (for GetOrders only).
Max length: 19 (Note: The eBay database specifies 38. Currently, transaction IDs are usually 9 to 12 digits.) .

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .TransactionPrice 		AmountType (double) Always Price of the transaction (before shipping and sales tax) that the buyer needs to pay to complete the purchase. Note that for GetItemTransactions and GetSellerTransactions, TransactionPrice is the per-item price for the transaction; transactions with TransactionArray.Transaction.QuantityPurchased of more than 1 have the same value for TransactionPrice as transactions with TransactionArray.Transaction.QuantityPurchased of 1. For eBay Motors, TransactionPrice is the deposit amount.

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .TransactionSiteID 		SiteCodeType Conditionally The site upon which the item transaction was made.

Applicable values: See TransactionSiteID.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Variation 		VariationType Conditionally Variations are multiple similar (but not identical) items in a single fixed-price (or Store Inventory Format) listing. For example, a single listing could contain multiple items of the same brand and model that vary by color and size (like "Blue, Large" and "Black, Medium"). Each variation can have its own quantity and price.

When a user purchases items from a multi-variation listing, this Variation node contains information about which variation was purchased. Therefore, applications that process transactions should always check to see if this node is present. A single transaction can contain items from only one variation.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Variation.SKU 		SKUType (string) Conditionally A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. eBay preserves the SKU on the variation, enabling you to obtain it before and after a transaction is created. 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 specified). If Item.InventoryTrackingMethod is set to true, the SKU values must be specified and they must be unique across all the seller's active listings. Only returned if the seller specified a SKU for the variation.
Max length: 70.

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

See Setting the Variation SKU.
OrderArray.Order
  .TransactionArray.Transaction
  .Variation.VariationSpecifics 		NameValueListArrayType Conditionally 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't add or change names or values in variation specifics (because the set of variation specifics serves as a unique identifier). However, you can 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 (transactions). 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:
    Setting Item Specifics for Variations
    Revising and Relisting with Variations

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

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

If the listing has varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node.

When you list with Item Variations:
a) Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node.
b) Specify up to five VariationSpecifics in each Variation node.
c) Specify all applicable names with all their supported values in the VariationSpecificSet node.

See the Variation sample in the AddFixedPriceItem call reference for examples.

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

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Variation.VariationSpecifics
  .NameValueList.Name 		string Conditionally A name in a name/value pair.

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

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

For GetCategorySpecifics and GetItemRecommendations: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer").

For search calls: In the GetSearchResults response, this the name of an attribute (Attribute) that was used in the listing. Specifically: If SearchRequest was used to perform a "Product Finder" search, this contains the name of one attribute (i.e, the name of one ID-based Item Specifics field). If IncludeCondition was true in the request, this returns the condition attribute name (e.g., "Item Condition").

In the GetProducts response, this is an attribute name that is defined for a catalog product.

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

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Variation.VariationSpecifics
  .NameValueList.Value 		string Conditionally,
repeatable: [0..*]		 A value associated with the name.

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

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

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

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

For search calls: In the GetSearchResults response, if SearchRequest was used to perform a "Product Finder" search, this contains the value of one attribute. If IncludeCondition was true in the request, this returns the condition attribute value (e.g., "New").

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

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .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 variations in transactions (for buyers and sellers).

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



Back to top

Input Output Detail Controls Samples Change History Top Errors for GetOrderTransactions
GetOrderTransactions Detail Controls


Detail Control: 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.

Detail Level value Summary of Effects
ReturnAll Returns all fields
ItemReturnDescription Returns all fields except the following:
  • OrderArray.Order.ExternalTransaction and its children
  • OrderArray.Order.ShippingDetails.TaxTable and its children
  • OrderArray.Order.TransactionArray.Transaction.Buyer and its children
  • OrderArray.Order.TransactionArray.Transaction.TransactionPlatform
none Same as for ItemReturnDescription

YThe field is always returned.
(Y)The field is conditionally returned. See the field description for clarification of conditions.
-The field is not returned.

Output Field none ItemReturnDescription ReturnAll
OrderArrayYYY
OrderArray.OrderYYY
OrderArray.Order.AdjustmentAmountYYY
OrderArray.Order.AmountPaidYYY
OrderArray.Order.AmountSavedYYY
OrderArray.Order.BuyerUserIDYYY
OrderArray.Order.CheckoutStatusYYY
OrderArray.Order.CheckoutStatus.eBayPaymentStatusYYY
OrderArray.Order.CheckoutStatus
  .IntegratedMerchantCreditCardEnabled		YYY
OrderArray.Order.CheckoutStatus.LastModifiedTimeYYY
OrderArray.Order.CheckoutStatus.PaymentMethodYYY
OrderArray.Order.CheckoutStatus.StatusYYY
OrderArray.Order.CreatedTimeYYY
OrderArray.Order.CreatingUserRoleYYY
OrderArray.Order.ExternalTransaction--(Y)
OrderArray.Order.ExternalTransaction.ExternalTransactionID--(Y)
OrderArray.Order.ExternalTransaction.ExternalTransactionTime--(Y)
OrderArray.Order.ExternalTransaction.FeeOrCreditAmount--(Y)
OrderArray.Order.ExternalTransaction.PaymentOrRefundAmount--(Y)
OrderArray.Order.IntegratedMerchantCreditCardEnabledYYY
OrderArray.Order.OrderIDYYY
OrderArray.Order.OrderStatusYYY
OrderArray.Order.PaidTime(Y)(Y)(Y)
OrderArray.Order.PaymentMethodsYYY
OrderArray.Order.ShippedTime(Y)(Y)(Y)
OrderArray.Order.ShippingAddressYYY
OrderArray.Order.ShippingAddress.AddressID(Y)(Y)(Y)
OrderArray.Order.ShippingAddress.AddressOwner(Y)(Y)(Y)
OrderArray.Order.ShippingAddress.CityName(Y)(Y)(Y)
OrderArray.Order.ShippingAddress.Country(Y)(Y)(Y)
OrderArray.Order.ShippingAddress.CountryName(Y)(Y)(Y)
OrderArray.Order.ShippingAddress.ExternalAddressID(Y)(Y)(Y)
OrderArray.Order.ShippingAddress.Name(Y)(Y)(Y)
OrderArray.Order.ShippingAddress.Phone(Y)(Y)(Y)
OrderArray.Order.ShippingAddress.PostalCode(Y)(Y)(Y)
OrderArray.Order.ShippingAddress.StateOrProvince(Y)(Y)(Y)
OrderArray.Order.ShippingAddress.Street1(Y)(Y)(Y)
OrderArray.Order.ShippingAddress.Street2(Y)(Y)(Y)
OrderArray.Order.ShippingDetailsYYY
OrderArray.Order.ShippingDetails.AllowPaymentEdit(Y)(Y)(Y)
OrderArray.Order.ShippingDetails.ChangePaymentInstructions(Y)(Y)(Y)
OrderArray.Order.ShippingDetails.CODCost(Y)(Y)(Y)
OrderArray.Order.ShippingDetails.ExcludeShipToLocation(Y)(Y)(Y)
OrderArray.Order.ShippingDetails.GetItFastYYY
OrderArray.Order.ShippingDetails.InsuranceFeeYYY
OrderArray.Order.ShippingDetails.InsuranceOptionYYY
OrderArray.Order.ShippingDetails.InsuranceWantedYYY
OrderArray.Order.ShippingDetails
  .InternationalShippingServiceOption		(Y)(Y)(Y)
OrderArray.Order.ShippingDetails
  .InternationalShippingServiceOption.ShippingInsuranceCost		(Y)(Y)(Y)
OrderArray.Order.ShippingDetails
  .InternationalShippingServiceOption.ShippingService		(Y)(Y)(Y)
OrderArray.Order.ShippingDetails
  .InternationalShippingServiceOption.ShippingServiceAdditionalCost		(Y)(Y)(Y)
OrderArray.Order.ShippingDetails
  .InternationalShippingServiceOption.ShippingServiceCost		(Y)(Y)(Y)
OrderArray.Order.ShippingDetails
  .InternationalShippingServiceOption.ShippingServicePriority		(Y)(Y)(Y)
OrderArray.Order.ShippingDetails
  .InternationalShippingServiceOption.ShipToLocation		(Y)(Y)(Y)
OrderArray.Order.ShippingDetails.SalesTaxYYY
OrderArray.Order.ShippingDetails.SalesTax.SalesTaxAmountYYY
OrderArray.Order.ShippingDetails.SalesTax.SalesTaxPercentYYY
OrderArray.Order.ShippingDetails.SalesTax.SalesTaxStateYYY
OrderArray.Order.ShippingDetails.SalesTax.ShippingIncludedInTaxYYY
OrderArray.Order.ShippingDetails.SellingManagerSalesRecordNumber(Y)(Y)(Y)
OrderArray.Order.ShippingDetails.ShippingServiceOptions(Y)(Y)(Y)
OrderArray.Order.ShippingDetails.ShippingServiceOptions
  .ExpeditedService		(Y)(Y)(Y)
OrderArray.Order.ShippingDetails.ShippingServiceOptions
  .ShippingInsuranceCost		(Y)(Y)(Y)
OrderArray.Order.ShippingDetails.ShippingServiceOptions
  .ShippingService		(Y)(Y)(Y)
OrderArray.Order.ShippingDetails.ShippingServiceOptions
  .ShippingServiceAdditionalCost		(Y)(Y)(Y)
OrderArray.Order.ShippingDetails.ShippingServiceOptions
  .ShippingServiceCost		(Y)(Y)(Y)
OrderArray.Order.ShippingDetails.ShippingServiceOptions
  .ShippingServicePriority		(Y)(Y)(Y)
OrderArray.Order.ShippingDetails.ShippingServiceOptions
  .ShippingSurcharge		(Y)(Y)(Y)
OrderArray.Order.ShippingDetails.TaxTable--(Y)
OrderArray.Order.ShippingDetails.TaxTable.TaxJurisdiction--(Y)
OrderArray.Order.ShippingDetails.TaxTable.TaxJurisdiction
  .JurisdictionID		--(Y)
OrderArray.Order.ShippingDetails.TaxTable.TaxJurisdiction
  .SalesTaxPercent		--(Y)
OrderArray.Order.ShippingDetails.TaxTable.TaxJurisdiction
  .ShippingIncludedInTax		--(Y)
OrderArray.Order.ShippingServiceSelectedYYY
OrderArray.Order.ShippingServiceSelected.ExpeditedService(Y)(Y)(Y)
OrderArray.Order.ShippingServiceSelected.ShippingInsuranceCost(Y)(Y)(Y)
OrderArray.Order.ShippingServiceSelected.ShippingService(Y)(Y)(Y)
OrderArray.Order.ShippingServiceSelected
  .ShippingServiceAdditionalCost		(Y)(Y)(Y)
OrderArray.Order.ShippingServiceSelected.ShippingServiceCost(Y)(Y)(Y)
OrderArray.Order.ShippingServiceSelected.ShippingServicePriority(Y)(Y)(Y)
OrderArray.Order.ShippingServiceSelected.ShippingSurcharge(Y)(Y)(Y)
OrderArray.Order.SubtotalYYY
OrderArray.Order.TotalYYY
OrderArray.Order.TransactionArrayYYY
OrderArray.Order.TransactionArray.TransactionYYY
OrderArray.Order.TransactionArray.Transaction.AdjustmentAmount(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.AmountPaid(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.BestOfferSale(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer.AboutMePage--(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer.BuyerInfo--(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer.BuyerInfo
  .ShippingAddress		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer.BuyerInfo
  .ShippingAddress.AddressID		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer.BuyerInfo
  .ShippingAddress.AddressOwner		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer.BuyerInfo
  .ShippingAddress.CityName		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer.BuyerInfo
  .ShippingAddress.Country		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer.BuyerInfo
  .ShippingAddress.CountryName		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer.BuyerInfo
  .ShippingAddress.ExternalAddressID		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer.BuyerInfo
  .ShippingAddress.Name		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer.BuyerInfo
  .ShippingAddress.Phone		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer.BuyerInfo
  .ShippingAddress.PostalCode		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer.BuyerInfo
  .ShippingAddress.StateOrProvince		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer.BuyerInfo
  .ShippingAddress.Street1		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer.BuyerInfo
  .ShippingAddress.Street2		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer
  .eBayGoodStanding		--(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer.EIASToken--(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer.Email--(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer
  .FeedbackPrivate		--(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer
  .FeedbackRatingStar		--(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer.FeedbackScore--(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer.IDVerified--(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer.NewUser--(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer
  .RegistrationDate		--(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer.Site--(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer.Status--(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer
  .UserAnonymized		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer.UserID--(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer.UserIDChanged--(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer
  .UserIDLastChanged		--(Y)
OrderArray.Order.TransactionArray.Transaction.Buyer.VATStatus--(Y)
OrderArray.Order.TransactionArray.Transaction.BuyerGuaranteePrice(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.CartID(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction
  .ConvertedAdjustmentAmount		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.ConvertedAmountPaid(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction
  .ConvertedTransactionPrice		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.CreatedDateYYY
OrderArray.Order.TransactionArray.Transaction.DepositType(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.ExternalTransaction--(Y)
OrderArray.Order.TransactionArray.Transaction.ExternalTransaction
  .ExternalTransactionID		--(Y)
OrderArray.Order.TransactionArray.Transaction.ExternalTransaction
  .ExternalTransactionTime		--(Y)
OrderArray.Order.TransactionArray.Transaction.ExternalTransaction
  .FeeOrCreditAmount		--(Y)
OrderArray.Order.TransactionArray.Transaction.ExternalTransaction
  .PaymentOrRefundAmount		--(Y)
OrderArray.Order.TransactionArray.Transaction.FinalValueFee(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.ItemYYY
OrderArray.Order.TransactionArray.Transaction.Item
  .ApplicationData		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Item.AutoPayYYY
OrderArray.Order.TransactionArray.Transaction.Item
  .BuyerProtection		YYY
OrderArray.Order.TransactionArray.Transaction.Item.BuyItNowPrice(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Item.Charity(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Item.Charity
  .CharityID		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Item.Charity
  .CharityListing		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Item.Charity
  .CharityName		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Item.Charity
  .CharityNumber		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Item.Charity
  .DonationPercent		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Item.GetItFast(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Item
  .IntegratedMerchantCreditCardEnabled		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Item.ItemIDYYY
OrderArray.Order.TransactionArray.Transaction.Item.ListingTypeYYY
OrderArray.Order.TransactionArray.Transaction.Item.PrivateListingYYY
OrderArray.Order.TransactionArray.Transaction.Item.SellingStatusYYY
OrderArray.Order.TransactionArray.Transaction.Item.SellingStatus
  .ConvertedCurrentPrice		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Item.SellingStatus
  .CurrentPrice		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Item.SellingStatus
  .FinalValueFee		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Item.SellingStatus
  .ListingStatus		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.PayPalEmailAddress(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.PlatformY-Y
OrderArray.Order.TransactionArray.Transaction.QuantityPurchased(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction
  .SellerContactBuyerByEmail		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Status(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Status
  .BuyerSelectedShipping		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Status
  .CheckoutStatus		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Status
  .CompleteStatus		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Status
  .eBayPaymentStatus		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Status
  .IntegratedMerchantCreditCardEnabled		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Status
  .LastTimeModified		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Status
  .PaymentHoldStatus		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Status
  .PaymentMethodUsed		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.TransactionIDYYY
OrderArray.Order.TransactionArray.Transaction.TransactionPriceYYY
OrderArray.Order.TransactionArray.Transaction.TransactionSiteID(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.Variation(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Variation.SKU(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Variation
  .VariationSpecifics		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Variation
  .VariationSpecifics.NameValueList		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Variation
  .VariationSpecifics.NameValueList.Name		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Variation
  .VariationSpecifics.NameValueList.Value		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Variation
  .VariationTitle		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.Variation
  .VariationViewItemURL		(Y)(Y)(Y)



Back to top

Input Output Detail Controls Samples Change History Top Errors for GetOrderTransactions
GetOrderTransactions Samples

An inline sample will be added in a future release. Please refer to the Samples section of the eBay Web Services Guide chapter for GetOrderTransactions.



Back to top

Input Output Detail Controls Samples Change History Top Errors for GetOrderTransactions
GetOrderTransactions Change History
Version Description
635
2009-09-16
  • ExcludeShipToLocation (added): Sellers can now exclude specific regions and countries from where they will ship items.
  • InsuranceDetails, InsuranceFee, InsuranceOption, InternationalInsuranceDetails, InsuranceWanted, ShippingInsuranceCost (modified): Sellers can no longer give buyers the option to purchase shipping insurance for either domestic or international items. The buyer-paid shipping insurance option has been removed from the following sites:
    BEFR, BENL, CA, CAFR, HK, IE, IN, MY, Motors, NL, PH, PL, SG, UK, US
    Insurance tags are returned only when the associated item has buyer-paid shipping insurance values.
615
2008-04-29
  • Variation (added): Identifies a variation that was purchased from a multi-variation listing.
605
2009-02-18
  • (modified) A seller can now offer PayPal as a payment method for Adult Only items if the seller's registration site ID and registration address are in the US. A buyer can complete a transaction for an Adult Only listing with PayPal if the buyer's registration site ID and registration address are in the US.
603
2009-02-04
  • OrderArray.Order.IntegratedMerchantCreditCardEnabled (added): Indicates that the IntegratedMerchantCreditCard payment method applies.
  • OrderArray.Order.TransactionArray.Transaction.Status.IntegratedMerchantCreditCardEnabled (added): Indicates that the IntegratedMerchantCreditCard payment method applies.
  • Item.IntegratedMerchantCreditCardEnabled (added): Indicates that the IntegratedMerchantCreditCard payment method applies to the item.
  • OrderArray.Order.CheckoutStatus.IntegratedMerchantCreditCardEnabled (added): Indicates that the IntegratedMerchantCreditCard payment method applies.
587
2008-10-15
  • TransactionPlatformCodeType.WorldOfGood (added): The WorldOfGood site will now show up as a transaction platform.
573
2008-07-09
  • OrderArray.Order.TransactionArray.Transaction.Item.DigitalDeliveryDetails (deprecated): The digital delivery feature is disabled as of March 28, 2008. GetOrderTransactions no longer returns digital delivery details for digital download items.
567
2008-05-28
  • IncludeFinalValueFees (added): Used to retrieve the final value fee for an item, if any.
  • OrderArray.Order.TransactionArray.Transaction.FinalValueFee (added): The amount of the final value fee; see the Output fields, above, for more information.
563
2008-04-30
  • Transaction.BuyerGuaranteePrice (added): On the Australia site, by early June 2008, BuyerGuaranteePrice is the PayPal Buyer Protection coverage, offered for the item at the time of purchase. Details of coverage are in the following sections of the View Item page: the Buy Safely section and the Payment Details section.
  • BuyerProtection.NoCoverage (added): On the Australia site, by early June 2008, indicates that there is no PayPal Buyer Protection coverage.
561
2008-04-16
  • Item.ListingType.Express (deprecated): Due to the shutdown of UK and Germany eBay Express sites Item.ListingType.Express has been deprecated.
555
2008-03-05
  • ShippingDetails.CODCost (added): Applicable beginning in April. Applies to the Italy site (site ID 101). Contains the cost of cash-on-delivery shipping.
551
2008-02-06
  • PaymentHoldStatus (added): Applicable in the case of a PayPal payment by the buyer. Provides a status value related to the occurrence of a payment review hold or merchant hold.
537
2007-10-31
  • Item.PaymentMethods.PaisaPayEscrow, Item.PaymentMethods.PaisaPayEscrowEMI (added): These enum will be returned for items offering PaisaPayEscrow and PaisaPayEscrowEMI payment methods.
535
2007-10-17
  • PaidTime, ShippedTime (added): If the order has been marked as paid for or marked as shipped, the time is returned.
499
2007-02-07
  • ShippingDetails.AllowPaymentEdit (modified): Deleted previously deprecated objects from the latest schema. Some of these objects are still supported with lower request versions. See Deprecated Objects.
489
2006-11-29
  • (modified) Broadly corrected which fields are return with which DetailLevels. Added a summary above the DetailLevel table. Note: a technical limitation in the doc-generating tool results in incorrect DetailLevel information for Address-related fields under Order and Buyer. The details in the conceptual table are correct, and the tool limitation will be addressed in Q107.
485
2006-11-01
  • OrderArray.Order.ShippingDetails.InternationalShippingServiceOption.ShippingInsuranceCost (added): The insurance cost associated with shipping a single item with a given international shipping service.
483
2006-10-18
  • OrderArray.Order.CheckoutStatus.PaymentInProcess, OrderArray.Order.CheckoutStatus.PaymentFailure, OrderArray.Order.TransactionArray.Transaction.Status.PaymentInProcess, OrderArray.Order.TransactionArray.Transaction.Status.PaymentFailure (added): New payment status values have been added for future use.
477
2006-09-06
  • ListingType (modified): Chinese auction listings with Buy It Now are eligible for Express US.
  • ShippingTypes: CalculatedDomesticFlatInternational, FlatDomesticCalculatedInternational (added): Two more shipping types were introduced to enable a seller to use flat rate shipping for the domestic services and calculated shipping for the international shipping services, or vice versa. See the Shipping documentation for details.
  • BuyerPaymentMethodCodeType.ELV (added): Now supports a new payment method, enabling Express Germany to introduce bank payments through Elektronisches Lastschriftverfahren (direct debit). With ELV, a purchase amount is automatically deducted from a buyer's bank account, after the buyer has provided his or her bank details and agreed to the deduction.
  • OrderIDArray (modified): You can submit, at most, 20 OrderIDs. Any additional OrderIDs are ignored on input.
467
2006-06-28
  • OrderArray.Order.TransactionArray.Transaction.Item.DigitalDeliveryDetails (added): Returns empty for digital listing transactions.
459
2006-05-03
  • OrderArray.Order.TransactionArray.Transaction.TransactionPlatform (added): The platform (eBay or Express) on which the transaction was created.
453
2006-03-22
  • (added) New call.

This document was generated with a customized version of the apireferencedocs tool.

© 2005–2009 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.