GetOrderTransactions

Use this call to retrieve information about one or more orders based on OrderIDs, ItemIDs, or SKU values. The order types that can be retrieved with this call are discussed below:

See also Integrating PayPal With Your eBay Applications.

Global Shipping Program

With the Global Shipping Program, a seller can easily ship items to buyers in other countries with minimal concern for the complexities of international shipping such as customs duty and taxes, shipping regulations and restrictions. It's currently available only to sellers listing items on the eBay US site.

Sellers are presented with the option to join the Global Shipping Program on various pages of the eBay US site. Sellers will see this offer in promotional emails, at sign-in, on their My eBay page, and in other locations. Opting in to the program is done only from the web UI; there's no way to opt in using an API. Once opted in, sellers need not opt out again. They can simply choose not to offer the Global Shipping Program in their listings.

The features of the Global Shipping Program are implemented using some dedicated fields and some existing fields in GetOrderTransactions and other Trading API calls. For more information, see the Shipping chapter in the Trading API User's Guide.

Request Details

Unlike GetOrders, there are no time filters available in the GetOrderTransactions request. With GetOrderTransactions, you are either want to retrieve specific orders (using the OrderIDArray), or you want to find all orders associated with a particular item (and the item can be identified with an ItemID or SKU value. To find orders tied to a SKU value, the Item.InventoryTrackingMethod property (set at listing time) should be set to SKU.

Although it is possible to retrieve specific single line item orders through the ItemTransactionIDArray container using an ItemID/TransactionID pair or an OrderLineItemID value, the better solution might be to pass in one or more OrderLineItemID values into the OrderID field of the OrderIDArray container.

Testing GetOrderTransactions

You can test GetOrderTransactions in the Sandbox environment. To test the call, experiment with passing in one or more single and multiple line item OrderIDs into the OrderIDArray node and see if results are as expected. Similarly, pass in one or more ItemIDs or SKU values to see if the return results match the expected sales for those items.

Related Information

See Basic Building Blocks.

See also the reference documentation for these calls:



Back to top

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

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">
  <!-- Call-specific Input Fields -->
  <IncludeFinalValueFees> boolean </IncludeFinalValueFees>
  <ItemTransactionIDArray> ItemTransactionIDArrayType
    <ItemTransactionID> ItemTransactionIDType
      <ItemID> ItemIDType (string) </ItemID>
      <OrderLineItemID> string </OrderLineItemID>
      <SKU> SKUType (string) </SKU>
      <TransactionID> string </TransactionID>
    </ItemTransactionID>
    <!-- ... more ItemTransactionID nodes allowed here ... -->
  </ItemTransactionIDArray>
  <OrderIDArray> OrderIDArrayType
    <OrderID> OrderIDType (string) </OrderID>
    <!-- ... more OrderID values allowed here ... -->
  </OrderIDArray>
  <Platform> TransactionPlatformCodeType </Platform>
  <!-- Standard Input Fields -->
  <DetailLevel> DetailLevelCodeType </DetailLevel>
  <!-- ... more DetailLevel values allowed here ... -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <OutputSelector> string </OutputSelector>
  <!-- ... more OutputSelector values allowed here ... -->
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</GetOrderTransactionsRequest>
Argument Type Occurrence Meaning
Call-specific Input Fields [Jump to standard 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 for each order line item (Transaction container) for fixed-price listings. 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.
ItemTransactionIDArray ItemTransactionIDArrayType Conditional An array of one or more ItemTransactionID containers. Each ItemTransactionID container identifies an order line item to retrieve in the response.
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 Unique identifier for an eBay item listing. A listing can have multiple order line items (transactions), but only one ItemID. Unless an OrderLineItemID or SKU value is specified in the same node, this field is required for each ItemTransactionID node included in the request.
Max length: 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits).
ItemTransactionIDArray
  .ItemTransactionID
  .OrderLineItemID 		string Conditional OrderLineItemID is a unique identifier for an eBay order line item and is based upon the concatenation of ItemID and TransactionID, with a hyphen in between these two IDs. If an OrderLineItemID is included in a ItemTransactionID node in the request, the ItemID, TransactionID, and SKU fields are not required and are ignored if they are included in the request.

Max length: 50 (Note: The eBay database specifies 38. ItemIDs and TransactionIDs are usually 9 to 12 digits.).
ItemTransactionIDArray
  .ItemTransactionID.SKU 		SKUType (string) Conditional A SKU (stock keeping unit) is a unique identifier defined and used by the seller to identify a product or variation of an item. A listing can have multiple SKUs and it is possible that the same SKU can exist in multiple listings. Unless an OrderLineItemID or ItemID/TransactionID pair is specified in the same node, this field is required for each ItemTransactionID node included in the request. To retrieve order line items associated with a SKU, the InventoryTrackingMethod field must be set to SKU. The InventoryTrackingMethod field is set through AddFixedPriceItem or RelistFixedPriceItem.
Max length: 50.
ItemTransactionIDArray
  .ItemTransactionID
  .TransactionID 		string Conditional Unique identifier for an eBay order line item (transaction). The TransactionID should match the ItemID specified in each ItemTransactionID node included in the request. Optionally, an OrderLineItemID value can substitute for the ItemID/TransactionID pair.
Max length: 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.).
OrderIDArray OrderIDArrayType Conditional An array of one or more OrderID containers. Each OrderID container identifies an order to retrieve in the response. Up to 20 orders (using 20 OrderID containers) can be retrieved with one GetOrderTransactions call.
OrderIDArray.OrderID OrderIDType (string) Conditional,
repeatable: [0..*]		 A unique identifier that identifies a single line item or multiple line item (Combined Payment) order.

For the GetOrders and GetOrderTransactions calls, the OrderID field can handle a hyphenated OrderLineItemID value. OrderLineItemID is a unique identifier for an eBay transaction and is based upon the concatenation of ItemID and TransactionID with a hyphen in between these two IDs.

Platform TransactionPlatformCodeType Optional Name of the eBay co-branded site upon which the order line item was created. This will serve as a filter for the orders to get emitted in the response.

Applicable values:

•   CustomCode

(in/out) Reserved for future use.

•   eBay

(in/out) The order line item was created on the main eBay site.

•   Express

(in/out) The order line item was created on the eBay Express site.

•   Half

(in/out) The order line item was created on Half.com site.

•   Shopping

(in/out) The order line item was created on the Shopping.com site.

•   WorldOfGood

(in/out) The order line item was created on the WorldOfGood site.
Standard Input Fields  
DetailLevel DetailLevelCodeType Optional,
repeatable: [0..*]		 Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. For example, a particular detail level might cause the response to include buyer-related data in every result (e.g., for every Item), but no seller-related data. Specifying a detail level is like using a predefined attribute list in the SELECT clause of an SQL query. Use the DetailLevel element to specify the required detail level that the client application needs pertaining to the data components that are applicable to the request.

The DetailLevelCodeType defines the global list of available detail levels for all request types. Most request types support certain detail levels or none at all. If you pass a detail level that exists in the schema but that isn't valid for a particular request, eBay ignores it 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 Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned.

Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
OutputSelector string Optional,
repeatable: [0..*]		 You can use the OutputSelector field to restrict the data returned by 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:
    Routing the Request (Gateway URLs)
    eBay Schema Versioning Strategy
    Lowest Supported Version

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

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

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

We recommend that you only use this during development and debugging. Do not use this in requests 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.



Back to top

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

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

<?xml version="1.0" encoding="utf-8"?>
<GetOrderTransactionsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <OrderArray> OrderArrayType
    <Order> OrderType
      <AdjustmentAmount> AmountType (double) </AdjustmentAmount>
      <AmountPaid> AmountType (double) </AmountPaid>
      <AmountSaved> AmountType (double) </AmountSaved>
      <BuyerCheckoutMessage> string </BuyerCheckoutMessage>
      <BuyerUserID> UserIDType (string) </BuyerUserID>
      <CheckoutStatus> CheckoutStatusType
        <eBayPaymentMismatchDetails> eBayPaymentMismatchDetailsType
          <ActionRequiredBy> dateTime </ActionRequiredBy>
          <MismatchAmount> AmountType (double) </MismatchAmount>
          <MismatchType> MismatchTypeCodeType </MismatchType>
        </eBayPaymentMismatchDetails>
        <eBayPaymentStatus> PaymentStatusCodeType </eBayPaymentStatus>
        <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled>
        <LastModifiedTime> dateTime </LastModifiedTime>
        <PaymentMethod> BuyerPaymentMethodCodeType </PaymentMethod>
        <Status> CompleteStatusCodeType </Status>
      </CheckoutStatus>
      <CreatedTime> dateTime </CreatedTime>
      <CreatingUserRole> TradingRoleCodeType </CreatingUserRole>
      <ExternalTransaction> ExternalTransactionType
        <ExternalTransactionStatus> PaymentTransactionStatusCodeType </ExternalTransactionStatus>
        <ExternalTransactionTime> dateTime </ExternalTransactionTime>
        <FeeOrCreditAmount> AmountType (double) </FeeOrCreditAmount>
        <PaymentOrRefundAmount> AmountType (double) </PaymentOrRefundAmount>
      </ExternalTransaction>
      <!-- ... more ExternalTransaction nodes allowed here ... -->
      <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled>
      <IsMultiLegShipping> boolean </IsMultiLegShipping>
      <MonetaryDetails> PaymentsInformationType
        <Payments> PaymentInformationType
          <Payment> PaymentTransactionType
            <FeeOrCreditAmount> AmountType (double) </FeeOrCreditAmount>
            <Payee type="UserIdentityCodeType"> UserIdentityType (string) </Payee>
            <Payer type="UserIdentityCodeType"> UserIdentityType (string) </Payer>
            <PaymentAmount> AmountType (double) </PaymentAmount>
            <PaymentStatus> PaymentTransactionStatusCodeType </PaymentStatus>
            <PaymentTime> dateTime </PaymentTime>
            <ReferenceID type="TransactionReferenceCodeType"> TransactionReferenceType (string) </ReferenceID>
          </Payment>
          <!-- ... more Payment nodes allowed here ... -->
        </Payments>
      </MonetaryDetails>
      <MultiLegShippingDetails> MultiLegShippingDetailsType
        <SellerShipmentToLogisticsProvider> MultiLegShipmentType
          <ShippingServiceDetails> MultiLegShippingServiceType
            <ShippingService> token </ShippingService>
            <TotalShippingCost> AmountType (double) </TotalShippingCost>
          </ShippingServiceDetails>
          <ShippingTimeMax> int </ShippingTimeMax>
          <ShippingTimeMin> int </ShippingTimeMin>
          <ShipToAddress> AddressType
            <AddressID> string </AddressID>
            <AddressOwner> AddressOwnerCodeType </AddressOwner>
            <AddressUsage> AddressUsageCodeType </AddressUsage>
            <CityName> string </CityName>
            <Country> CountryCodeType </Country>
            <CountryName> string </CountryName>
            <ExternalAddressID> string </ExternalAddressID>
            <Name> string </Name>
            <Phone> string </Phone>
            <PostalCode> string </PostalCode>
            <ReferenceID> string </ReferenceID>
            <StateOrProvince> string </StateOrProvince>
            <Street1> string </Street1>
            <Street2> string </Street2>
          </ShipToAddress>
        </SellerShipmentToLogisticsProvider>
      </MultiLegShippingDetails>
      <OrderID> OrderIDType (string) </OrderID>
      <OrderStatus> OrderStatusCodeType </OrderStatus>
      <PaidTime> dateTime </PaidTime>
      <PaymentHoldDetails> PaymentHoldDetailType
        <ExpectedReleaseDate> dateTime </ExpectedReleaseDate>
        <NumOfReqSellerActions> int </NumOfReqSellerActions>
        <PaymentHoldReason> PaymentHoldReasonCodeType </PaymentHoldReason>
        <RequiredSellerActionArray> RequiredSellerActionArrayType
          <RequiredSellerAction> RequiredSellerActionCodeType </RequiredSellerAction>
          <!-- ... more RequiredSellerAction values allowed here ... -->
        </RequiredSellerActionArray>
      </PaymentHoldDetails>
      <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
      <PaymentMethods> BuyerPaymentMethodCodeType </PaymentMethods>
      <!-- ... more PaymentMethods values allowed here ... -->
      <RefundArray> RefundArrayType
        <Refund> RefundType
          <EstimatedRefundCompletionTime> dateTime </EstimatedRefundCompletionTime>
          <ExternalReferenceID> string </ExternalReferenceID>
          <RefundAmount> AmountType (double) </RefundAmount>
          <RefundCompletionTime> dateTime </RefundCompletionTime>
          <RefundFailureReason> RefundFailureReasonType
            <RefundFailureCode> RefundFailureCodeType </RefundFailureCode>
          </RefundFailureReason>
          <RefundFundingSourceArray> RefundFundingSourceArrayType
            <RefundFundingSource> RefundFundingSourceType
              <AccountNumber> string </AccountNumber>
              <BuyerExternalTransactionID> string </BuyerExternalTransactionID>
              <RefundAmount> AmountType (double) </RefundAmount>
              <RefundingSourceType> RefundingSourceTypeCodeType </RefundingSourceType>
              <SellerExternalTransactionID> string </SellerExternalTransactionID>
            </RefundFundingSource>
            <!-- ... more RefundFundingSource nodes allowed here ... -->
          </RefundFundingSourceArray>
          <RefundID> string </RefundID>
          <RefundRequestedTime> dateTime </RefundRequestedTime>
          <RefundStatus> RefundStatusCodeType </RefundStatus>
          <RefundTransactionArray> RefundTransactionArrayType
            <RefundTransaction> RefundTransactionType
              <ItemID> string </ItemID>
              <OrderID> string </OrderID>
              <RefundLineArray> RefundLineArrayType
                <RefundLine type="RefundLineTypeCodeType"> RefundLineType (AmountType) </RefundLine>
                <!-- ... more RefundLine values allowed here ... -->
              </RefundLineArray>
              <TransactionID> string </TransactionID>
            </RefundTransaction>
            <!-- ... more RefundTransaction nodes allowed here ... -->
          </RefundTransactionArray>
          <SellerNoteToBuyer> string </SellerNoteToBuyer>
        </Refund>
        <!-- ... more Refund nodes allowed here ... -->
      </RefundArray>
      <ShippedTime> dateTime </ShippedTime>
      <ShippingAddress> AddressType
        <AddressID> string </AddressID>
        <AddressOwner> AddressOwnerCodeType </AddressOwner>
        <AddressUsage> AddressUsageCodeType </AddressUsage>
        <CityName> string </CityName>
        <Country> CountryCodeType </Country>
        <CountryName> string </CountryName>
        <ExternalAddressID> string </ExternalAddressID>
        <Name> string </Name>
        <Phone> string </Phone>
        <PostalCode> string </PostalCode>
        <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 values allowed here ... -->
        <GetItFast> boolean </GetItFast>
        <InsuranceFee> AmountType (double) </InsuranceFee>
        <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
        <InsuranceWanted> boolean </InsuranceWanted>
        <InternationalShippingServiceOption> InternationalShippingServiceOptionsType
          <ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge>
          <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 values allowed here ... -->
        </InternationalShippingServiceOption>
        <!-- ... more InternationalShippingServiceOption nodes allowed here ... -->
        <SalesTax> SalesTaxType
          <SalesTaxAmount> AmountType (double) </SalesTaxAmount>
          <SalesTaxPercent> float </SalesTaxPercent>
          <SalesTaxState> string </SalesTaxState>
          <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
        </SalesTax>
        <SellingManagerSalesRecordNumber> int </SellingManagerSalesRecordNumber>
        <ShipmentTrackingDetails> ShipmentTrackingDetailsType
          <ShipmentTrackingNumber> string </ShipmentTrackingNumber>
          <ShippingCarrierUsed> string </ShippingCarrierUsed>
        </ShipmentTrackingDetails>
        <!-- ... more ShipmentTrackingDetails nodes allowed here ... -->
        <ShippingServiceOptions> ShippingServiceOptionsType
          <ExpeditedService> boolean </ExpeditedService>
          <ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge>
          <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 allowed here ... -->
        <TaxTable> TaxTableType
          <TaxJurisdiction> TaxJurisdictionType
            <JurisdictionID> string </JurisdictionID>
            <SalesTaxPercent> float </SalesTaxPercent>
            <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
          </TaxJurisdiction>
          <!-- ... more TaxJurisdiction nodes allowed here ... -->
        </TaxTable>
      </ShippingDetails>
      <ShippingServiceSelected> ShippingServiceOptionsType
        <ExpeditedService> boolean </ExpeditedService>
        <ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge>
        <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
          <ActualHandlingCost> AmountType (double) </ActualHandlingCost>
          <ActualShippingCost> AmountType (double) </ActualShippingCost>
          <AdjustmentAmount> AmountType (double) </AdjustmentAmount>
          <AmountPaid> AmountType (double) </AmountPaid>
          <BestOfferSale> boolean </BestOfferSale>
          <Buyer> UserType
            <AboutMePage> boolean </AboutMePage>
            <eBayGoodStanding> boolean </eBayGoodStanding>
            <EIASToken> string </EIASToken>
            <Email> string </Email>
            <FeedbackPrivate> boolean </FeedbackPrivate>
            <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
            <FeedbackScore> int </FeedbackScore>
            <IDVerified> boolean </IDVerified>
            <NewUser> boolean </NewUser>
            <RegistrationDate> dateTime </RegistrationDate>
            <Site> SiteCodeType </Site>
            <StaticAlias> string </StaticAlias>
            <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
            <ExternalTransactionStatus> PaymentTransactionStatusCodeType </ExternalTransactionStatus>
            <ExternalTransactionTime> dateTime </ExternalTransactionTime>
            <FeeOrCreditAmount> AmountType (double) </FeeOrCreditAmount>
            <PaymentOrRefundAmount> AmountType (double) </PaymentOrRefundAmount>
          </ExternalTransaction>
          <!-- ... more ExternalTransaction nodes allowed here ... -->
          <FinalValueFee> AmountType (double) </FinalValueFee>
          <IntangibleItem> boolean </IntangibleItem>
          <InvoiceSentTime> dateTime </InvoiceSentTime>
          <IsMultiLegShipping> boolean </IsMultiLegShipping>
          <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>
          <MonetaryDetails> PaymentsInformationType
            <Payments> PaymentInformationType
              <Payment> PaymentTransactionType
                <FeeOrCreditAmount> AmountType (double) </FeeOrCreditAmount>
                <Payee type="UserIdentityCodeType"> UserIdentityType (string) </Payee>
                <Payer type="UserIdentityCodeType"> UserIdentityType (string) </Payer>
                <PaymentAmount> AmountType (double) </PaymentAmount>
                <PaymentStatus> PaymentTransactionStatusCodeType </PaymentStatus>
                <PaymentTime> dateTime </PaymentTime>
                <ReferenceID type="TransactionReferenceCodeType"> TransactionReferenceType (string) </ReferenceID>
              </Payment>
              <!-- ... more Payment nodes allowed here ... -->
            </Payments>
          </MonetaryDetails>
          <OrderLineItemID> string </OrderLineItemID>
          <PaymentHoldDetails> PaymentHoldDetailType
            <ExpectedReleaseDate> dateTime </ExpectedReleaseDate>
            <NumOfReqSellerActions> int </NumOfReqSellerActions>
            <PaymentHoldReason> PaymentHoldReasonCodeType </PaymentHoldReason>
            <RequiredSellerActionArray> RequiredSellerActionArrayType
              <RequiredSellerAction> RequiredSellerActionCodeType </RequiredSellerAction>
              <!-- ... more RequiredSellerAction values allowed here ... -->
            </RequiredSellerActionArray>
          </PaymentHoldDetails>
          <PayPalEmailAddress> string </PayPalEmailAddress>
          <Platform> TransactionPlatformCodeType </Platform>
          <QuantityPurchased> int </QuantityPurchased>
          <RefundArray> RefundArrayType
            <Refund> RefundType
              <EstimatedRefundCompletionTime> dateTime </EstimatedRefundCompletionTime>
              <ExternalReferenceID> string </ExternalReferenceID>
              <RefundAmount> AmountType (double) </RefundAmount>
              <RefundCompletionTime> dateTime </RefundCompletionTime>
              <RefundFailureReason> RefundFailureReasonType
                <RefundFailureCode> RefundFailureCodeType </RefundFailureCode>
              </RefundFailureReason>
              <RefundFundingSourceArray> RefundFundingSourceArrayType
                <RefundFundingSource> RefundFundingSourceType
                  <AccountNumber> string </AccountNumber>
                  <BuyerExternalTransactionID> string </BuyerExternalTransactionID>
                  <RefundAmount> AmountType (double) </RefundAmount>
                  <RefundingSourceType> RefundingSourceTypeCodeType </RefundingSourceType>
                  <SellerExternalTransactionID> string </SellerExternalTransactionID>
                </RefundFundingSource>
                <!-- ... more RefundFundingSource nodes allowed here ... -->
              </RefundFundingSourceArray>
              <RefundID> string </RefundID>
              <RefundRequestedTime> dateTime </RefundRequestedTime>
              <RefundStatus> RefundStatusCodeType </RefundStatus>
              <RefundTransactionArray> RefundTransactionArrayType
                <RefundTransaction> RefundTransactionType
                  <ItemID> string </ItemID>
                  <OrderID> string </OrderID>
                  <RefundLineArray> RefundLineArrayType
                    <RefundLine type="RefundLineTypeCodeType"> RefundLineType (AmountType) </RefundLine>
                    <!-- ... more RefundLine values allowed here ... -->
                  </RefundLineArray>
                  <TransactionID> string </TransactionID>
                </RefundTransaction>
                <!-- ... more RefundTransaction nodes allowed here ... -->
              </RefundTransactionArray>
              <SellerNoteToBuyer> string </SellerNoteToBuyer>
            </Refund>
            <!-- ... more Refund nodes allowed here ... -->
          </RefundArray>
          <SellerContactBuyerByEmail> boolean </SellerContactBuyerByEmail>
          <SellerDiscounts> SellerDiscountsType
            <OriginalItemPrice> AmountType (double) </OriginalItemPrice>
            <OriginalItemShippingCost> AmountType (double) </OriginalItemShippingCost>
            <SellerDiscount> SellerDiscountType
              <CampaignDisplayName> string </CampaignDisplayName>
              <CampaignID> long </CampaignID>
              <ItemDiscountAmount> AmountType (double) </ItemDiscountAmount>
              <ShippingDiscountAmount> AmountType (double) </ShippingDiscountAmount>
            </SellerDiscount>
            <!-- ... more SellerDiscount nodes allowed here ... -->
          </SellerDiscounts>
          <Status> TransactionStatusType
            <BuyerSelectedShipping> boolean </BuyerSelectedShipping>
            <CheckoutStatus> CheckoutStatusCodeType </CheckoutStatus>
            <CompleteStatus> CompleteStatusCodeType </CompleteStatus>
            <eBayPaymentMismatchDetails> eBayPaymentMismatchDetailsType
              <ActionRequiredBy> dateTime </ActionRequiredBy>
              <MismatchAmount> AmountType (double) </MismatchAmount>
              <MismatchType> MismatchTypeCodeType </MismatchType>
            </eBayPaymentMismatchDetails>
            <eBayPaymentStatus> PaymentStatusCodeType </eBayPaymentStatus>
            <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled>
            <LastTimeModified> dateTime </LastTimeModified>
            <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
            <PaymentMethodUsed> BuyerPaymentMethodCodeType </PaymentMethodUsed>
          </Status>
          <Taxes> TaxesType
            <TaxDetails> TaxDetailsType
              <Imposition> TaxTypeCodeType </Imposition>
              <TaxAmount> AmountType (double) </TaxAmount>
              <TaxDescription> TaxDescriptionCodeType </TaxDescription>
              <TaxOnHandlingAmount> AmountType (double) </TaxOnHandlingAmount>
              <TaxOnShippingAmount> AmountType (double) </TaxOnShippingAmount>
              <TaxOnSubtotalAmount> AmountType (double) </TaxOnSubtotalAmount>
            </TaxDetails>
            <!-- ... more TaxDetails nodes allowed here ... -->
            <TotalTaxAmount> AmountType (double) </TotalTaxAmount>
          </Taxes>
          <TransactionID> string </TransactionID>
          <TransactionPrice> AmountType (double) </TransactionPrice>
          <TransactionSiteID> SiteCodeType </TransactionSiteID>
          <UnpaidItem> UnpaidItemType
            <Status> UnpaidItemCaseStatusTypeCodeType </Status>
            <Type> UnpaidItemCaseOpenTypeCodeType </Type>
          </UnpaidItem>
          <Variation> VariationType
            <SKU> SKUType (string) </SKU>
            <VariationSpecifics> NameValueListArrayType
              <NameValueList> NameValueListType
                <Name> string </Name>
                <Value> string </Value>
                <!-- ... more Value values allowed here ... -->
              </NameValueList>
              <!-- ... more NameValueList nodes allowed here ... -->
            </VariationSpecifics>
            <!-- ... more VariationSpecifics nodes allowed here ... -->
            <VariationTitle> string </VariationTitle>
            <VariationViewItemURL> anyURI </VariationViewItemURL>
          </Variation>
        </Transaction>
        <!-- ... more Transaction nodes allowed here ... -->
      </TransactionArray>
    </Order>
    <!-- ... more Order nodes allowed here ... -->
  </OrderArray>
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</GetOrderTransactionsResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard 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 Listing an Item.
OrderArray.Order
  .AdjustmentAmount 		AmountType (double) Always This value indicates the dollar amount by which the buyer has adjusted the order total. Adjustments to order costs may include shipping and handling, shipping insurance, buyer discounts, or added services. A positive amount indicates the amount is an extra charge being paid to the seller by the buyer. A negative value indicates this amount is a credit given to the buyer by the seller.

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.AmountPaid AmountType (double) Conditionally This value indicates the total amount of the order. This amount includes the sale price of each line item, shipping and handling charges, shipping insurance (if offered and selected by the buyer), additional services, and any applied sales tax. This value is returned after the buyer has completed checkout (the CheckoutStatus.Status output field reads 'Complete').

Note: For auction listings on North American sites and on eBay Motors Parts and Accessories, the AmountPaid value minus any applied sales tax is the amount subject to the final value fee calculation. The sales tax amount is returned in the ShippingDetails.SalesTax.SalesTaxAmount field. For more information on how final value fees are calculated, see the final value fees help page.
Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.AmountSaved AmountType (double) Always This value indicates the shipping discount experienced by the buyer as a result of creating a Combined Payment order. This value is returned as 0.00 for single line item orders.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .BuyerCheckoutMessage 		string Conditionally This field is returned if the buyer left a message for the seller during checkout.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.BuyerUserID UserIDType (string) Always eBay 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 Container consisting of details related to the current checkout status of the order.

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .CheckoutStatus
  .eBayPaymentMismatchDetails 		eBayPaymentMismatchDetailsType Conditionally This container is returned when a buyer's payment does not match the total cost of an order going through the new eBay payment process. This container is only applicable for German and Austrian orders going through the new eBay payment process, and if the buyer has selected EFT as the payment method.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .CheckoutStatus
  .eBayPaymentMismatchDetails
  .ActionRequiredBy 		dateTime Conditionally This dateTime value indicates the date by which the seller needs to accept or reject the overpayment/underpayment. If the seller doesn't take action by this date, eBay returns the payment to the buyer and essentially voids the sale. This field is always returned with the eBayPaymentMismatchDetails container.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.


DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .CheckoutStatus
  .eBayPaymentMismatchDetails
  .MismatchAmount 		AmountType (double) Conditionally This value indicates the amount in which the buyer's payment was either over (MismatchType=OverPayment) or under (MismatchType=UnderPayment) the actual total cost of an order going through the new eBay payment process.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.


DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .CheckoutStatus
  .eBayPaymentMismatchDetails
  .MismatchType 		MismatchTypeCodeType Conditionally This enumeration value indicates if the buyer has overpaid or underpaid for an order going through the new eBay payment process. This field is always returned with the eBayPaymentMismatchDetails container.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.


Applicable values:

•   CustomCode

(out) Reserved for internal or future use

•   OverPayment

(out) This value indicates that the buyer paid more than the required amount.

•   UnderPayment

(out) This value indicates that the buyer paid less than the required amount.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .CheckoutStatus
  .eBayPaymentStatus 		PaymentStatusCodeType Always This value indicates the payment status of an order.

Also applicable to Half.com orders (GetOrders only).

Applicable values:

•   BuyerCreditCardFailed

(out) This value indicates that the buyer's payment via a credit card failed. This value is only applicable if the seller accepts credit cards as a form of payment.

•   BuyerECheckBounced

(out) This value indicates that the buyer's eCheck bounced. This value is only applicable if the seller accepts eChecks as a form of payment.

•   BuyerFailedPaymentReportedBySeller

(out) This value indicates that the seller reported the buyer's payment as failed.

•   CustomCode

(out) Reserved for internal or future use.

•   NoPaymentFailure

(out) This value indicates that the buyer's payment for the order has cleared. A CheckoutStatus.eBayPaymentStatus value of 'NoPaymentFailure' and a CheckoutStatus.Status value of 'Complete' indicates that checkout is complete.

•   PaymentInProcess

(out) This value indicates that the buyer's non-PayPal payment is in process. This value is only applicable if the buyer has selected a payment method other than PayPal.

•   PayPalPaymentInProcess

(out) This value indicates that the buyer's PayPal payment is in process. This value is only applicable if the buyer has selected PayPal as the payment method.




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 Indicates the last time that there was a change in value of the CheckoutStatus.Status field, such as 'Pending' to 'Complete'.

This field is also applicable to Half.com orders (GetOrders only).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .CheckoutStatus.PaymentMethod 		BuyerPaymentMethodCodeType Always The payment method that the buyer selected to pay for the order.

This field is also applicable to Half.com orders (GetOrders only).

Applicable values: See PaymentMethod.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .CheckoutStatus.Status 		CompleteStatusCodeType Always Indicates the status of the order. This value is subject to change based on the status of the checkout flow. Generally speaking, the Status field reads 'Incomplete' when payment has yet to be initiated, 'Pending' when payment has been initiated but is in process, and 'Complete' when the payment process has completed.

Note: If the PaymentMethod is CashOnPickup, the Status value will read Complete right at Checkout, even though the seller may not have been officially paid yet, and the eBayPaymentStatus field will read NoPaymentFailure. The CheckoutStatus.Status value will remain as Complete even if the seller uses ReviseCheckoutStatus to change the checkout status to Pending. However, the eBayPaymentStatus value in GetOrders will change from NoPaymentFailure to PaymentInProcess.

This field is also applicable to Half.com orders (GetOrders only).

Applicable values:

•   Complete

(in/out) The order is complete. Generally speaking, an order is complete when payment from the buyer has been initiated and processed.

Note: If the PaymentMethodUsed is 'CashOnPickup', the CheckoutStatus.Status value in GetOrders will be 'Complete' right at Checkout, even though the seller may not have been officially paid yet. The CheckoutStatus.Status value in GetOrders will remain as 'Complete' even if the seller uses ReviseCheckoutStatus to change the checkout status to Pending. However, the eBayPaymentStatus value in GetOrders will change from 'NoPaymentFailure' to 'PaymentInProcess'.

•   CustomCode

(in/out) Reserved for internal or future use

•   Incomplete

(in/out) The order is incomplete. Generally speaking, an order is incomplete when payment from the buyer has yet to be initiated.

•   Pending

(in/out) The order is pending. Generally speaking, an order is pending when payment from the buyer has been initiated but has yet to be fully processed.

Note: If the PaymentMethod is CashOnPickup, the CheckoutStatus.Status value in GetOrders will read Complete right at Checkout, even though the seller may not have been officially paid yet. The CheckoutStatus.Status value in GetOrders will remain as Complete even if the seller uses ReviseCheckoutStatus to change the checkout status to Pending. However, the eBayPaymentStatus value in GetOrders will change from NoPaymentFailure to PaymentInProcess.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.CreatedTime dateTime Always Timestamp that indicates the date and time that the order was created. For single line item orders, this value is the same as CreatedDate in the Transaction container.

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .CreatingUserRole 		TradingRoleCodeType Conditionally This value indicates whether a Combined Payment order was created by the buyer or by the seller. This field is only returned for Combined Payment orders.

Applicable values:

•   Buyer

(in/out) The eBay user is acting as the buyer for the order(s). In GetOrders, this value should be passed into the OrderRole field in the request to retrieve orders in which the calling eBay user is the buyer in the order.

•   CustomCode

(in/out) This value is reserved for future or internal use.

•   Seller

(in/out) The eBay user is acting as the seller for the order(s). In GetOrders, this value should be passed into the OrderRole field in the request to retrieve orders in which the calling eBay user is the seller in the order.




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

For orders in which the seller's funds are being held by PayPal, the PaymentHoldDetails container and PaymentHoldStatus field will be returned instead of the ExternalTransaction container.

Note: In an upcoming release, ExternalTransaction will be replaced by the more versatile MonetaryDetails container, so you are encouraged to start using MonetaryDetails now. Not applicable to Half.com.

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

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Failed

(out) The payment has been processed, but was not received by the payee.

•   Pending

(out) Payment has been initiated and is being processed.

•   Succeeded

(out) The payment was received by the payee.




DetailLevel: ReturnAll.
OrderArray.Order
  .ExternalTransaction
  .ExternalTransactionTime 		dateTime Conditionally Timestamp for payment transaction.

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

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
  .IsMultiLegShipping 		boolean Conditionally If IsMultilegShipping is true, the order or transaction uses the Global Shipping Program, in which the shipment has a domestic leg and an international leg. The buyer's shipping address is in a country other than the country where the items were listed, and the seller has specified InternationalPriorityShipping as the default international shipping service in the listings of all the items in the shipment.

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

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .MonetaryDetails 		PaymentsInformationType Conditionally Contains information about how funds exchanged for an order are allocated to payees.

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

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

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

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

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

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

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .MonetaryDetails.Payments
  .Payment.Payee 		UserIdentityType (string) Conditionally The person or organization who is to receive the payment allocation.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .MonetaryDetails.Payments
  .Payment.Payee
  [ attribute type ]		 UserIdentityCodeType Conditionally Type of user involved in an exchange of funds for an order.

For a list of possible enumeration values, see UserIdentityCodeType.
OrderArray.Order
  .MonetaryDetails.Payments
  .Payment.Payer 		UserIdentityType (string) Conditionally The person or organization who submitted the payment.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .MonetaryDetails.Payments
  .Payment.Payer
  [ attribute type ]		 UserIdentityCodeType Conditionally Type of user involved in an exchange of funds for an order.

For a list of possible enumeration values, see UserIdentityCodeType.
OrderArray.Order
  .MonetaryDetails.Payments
  .Payment.PaymentAmount 		AmountType (double) Conditionally The amount of the payment that is allocated to the payee.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .MonetaryDetails.Payments
  .Payment.PaymentStatus 		PaymentTransactionStatusCodeType Conditionally The current status of a buyer payment that is allocated to a specified payee.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Failed

(out) The payment has been processed, but was not received by the payee.

•   Pending

(out) Payment has been initiated and is being processed.

•   Succeeded

(out) The payment was received by the payee.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .MonetaryDetails.Payments
  .Payment.PaymentTime 		dateTime Conditionally The date and time when the payment is received by the payee.

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

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

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .MonetaryDetails.Payments
  .Payment.ReferenceID
  [ attribute type ]		 TransactionReferenceCodeType Conditionally The type of transaction ID for this payment.

For a list of possible enumeration values, see TransactionReferenceCodeType.
OrderArray.Order
  .MultiLegShippingDetails 		MultiLegShippingDetailsType Conditionally Contains details about the domestic leg of a Global Shipping Program shipment.

This information is not returned if IsMultilegShipping is false.

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

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

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

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

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingTimeMax 		int Conditionally The maximum guaranteed number of days that the shipping carrier will take to ship an item for the domestic leg of a Global Shipping Program shipment (not including the handling time it takes the seller to deliver the item to the domestic shipping carrier).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingTimeMin 		int Conditionally The minimum number of days that the shipping carrier will take to ship an item for the domestic leg of a Global Shipping Program shipment (not including the handling time it takes the seller to deliver the item to the domestic shipping carrier).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress 		AddressType Conditionally Contains shipping address information for the domestic leg of a Global Shipping Program shipment. This container includes the ReferenceID field, which can be printed on the package to give the international shipping provider a unique identifier for the order.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.AddressID 		string Conditionally Unique ID for a user's address in the eBay database. This value can help prevent the need to store an address multiple times across multiple orders. The ID changes if a user changes their address.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.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
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.AddressUsage 		AddressUsageCodeType Conditionally This tag tells whether current address is a default shipping address or one of the shipping addresses in address book.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   DefaultShipping

(out) This is default shipping address which is rendered to buyer on checkout.

•   Invalid

(out) This is not a valid address. Please use another address.

•   Shipping

(out) This is an address which is in user's address book. It can be used at the time of checkout.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.CityName 		string Conditionally The name of the user's city. Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. .

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.Country 		CountryCodeType Conditionally The two-digit code representing the country 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.

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

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

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress
  .ExternalAddressID 		string Conditionally ID assigned to the address by the address owner, e.g. by the PayPal system. Currently, the ExternalAddressID only applies for a customer address in the PayPal system. The ID changes if a user changes their address. Also see the AddressOwner field. The ExternalAddressID value also is applicable to Half.com (for GetOrders).
Max length: 20.

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

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

In the US, the area code (3 digits), the prefix (3 digits), the line number (4 digits), and phone extension (if specified by the user) are returned in this field. The extension can be one or more digits. Non-breaking spaces are used as delimiters between these phone number components.

Also applicable to Half.com (for GetOrders).
Max length: eBay validates the content (should only be integer values and delimiters), but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. .

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

For a Global Shipping Program order, GetSellerList and GetMyeBaySelling return the postal code of the buyer, not that of the international shipping provider.

Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 9 (not counting delimiter characters) for the US. Note: The eBay database allocates up to 24 characters for this field. .

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

Example: "Reference #1234567890123456"

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.StateOrProvince 		string Conditionally The region of the user's address. Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. .

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.Street1 		string Conditionally Line 1 of the user's street address. Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. .

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.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: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. .

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.OrderID OrderIDType (string) Always A unique identifier that identifies a single line item or multiple line item order.

For a single line item order, the OrderID value is identical to the OrderLineItemID value that is generated upon creation of the order line item. For a Combined Payment order or an order that goes through the eBay shopping cart flow, the OrderID value is automatically created by eBay. A Combined Payment order can be created through the site by a buyer or seller when the buyer or seller share multiple, common order line items. A Combined Payment order can also be created by the seller through the AddOrder call.

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

Also applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.OrderStatus OrderStatusCodeType Always This enumeration value indicates the current status of the order.

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.

•   All

(out) All the orders with active and completed status

•   Authenticated

(out) The cart was authenticated.

•   Cancelled

(in/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

(in/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 Timestamp indicating the date and time of order payment. This field is not returned until payment has been made by the buyer.

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.

Applicable to Half.com (for GetOrders).

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

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

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .PaymentHoldDetails
  .ExpectedReleaseDate 		dateTime Always Timestamp that indicates the expected date in which eBay/PayPal will distribute the funds to the seller's account. This is not a firm date and is subject to change.

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

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

Applicable values:

•   BelowStandardSeller

(out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller has been classified as a Below Standard seller.

•   CasualSeller

(out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller is classified as a casual seller on eBay.

•   CustomCode

(out) This value is reserved for internal or future use.

•   EbpCaseOpen

(out) This value indicates that the buyer's payment for the order is being held by PayPal because an eBay Buyer Protection case has been filed against the order. If this value is returned, the seller can expedite the release of PayPal funds into their account by resolving the eBay Buyer Protection case, as indicated by a value of 'ResolveeBPCase' returned in a PaymentHoldDetails.RequiredSellerActionArray.RequiredSellerAction field.

•   NewPaypalAccountAdded

(out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller's PayPal account (identified in Transaction.PayPalEmailAddress) is new and is not fully set up to receive funds.

•   NewSeller

(out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller is new to selling on eBay. Sellers are considered "new" until they have met all three criteria below:

  • More than 90 days have passed since first successful sale
  • More than 25 domestic sales
  • More than $250.00 in total sales

•   NotAvailable

(out) This value indicates that the reason for the buyer's payment for the order being held by PayPal is not known.

•   Other

(out) This value is returned if the reason for the buyer's payment for the order being held by PayPal cannot be classified by any of the other enumeration values.

•   ReinstatementAfterSuspension

(out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller has recently been reinstated as an active eBay seller after their account went through a suspension/restricted period.

After a seller's account is suspended and then reinstated, that seller is treated as a new seller, and must meet the same requirements that a new seller must meet to get beyong the "New Seller" status.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .PaymentHoldDetails
  .RequiredSellerActionArray 		RequiredSellerActionArrayType Always Container consisting of one or more RequiredSellerAction fields. RequiredSellerAction fields provide possible actions that a seller can take to expedite the release of funds into their account.

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

Applicable values:

•   ContacteBayCS

(out) This value indicates that the seller should contact eBay Customer Support to discover the next required action to expedite the release of funds into their account.

•   CustomCode

(out) This value is reserved for internal or future use.

•   MarkAsShipped

(out) This value indicates that the seller must mark the order line item as shipped to expedite the release of funds into their account. The seller can use the CompleteSale call to mark an item as shipped. If an order line item is marked as shipped, it is possible that the seller's funds for the order will be released as soon as seven days after the latest estimated delivery date.

•   None

(out) This value is not currently applicable since the new eBay Payment Process for DE and AT sellers has been rolled back indefinitely.

•   ResolveBuyerMessageInr

(out) This value indicates that the buyer has not received the item, and the buyer has contacted the seller through the eBay system in an effort to resolve the issue with the seller. The seller must make it right with the buyer in order to expedite the release of funds into their account.

•   ResolveBuyerMessageSnad

(out) This value indicates that the buyer has received the item, but the item is not as described in the listing; hence, the buyer has contacted the seller through the eBay system in an effort to resolve the issue with the seller. The seller must make it right with the buyer in order to expedite the release of funds into their account.

•   ResolveeBPCase

(out) This value indicates that there is an open eBay Buyer Protection case involving the seller and the item. The seller must address and get the case resolved before the funds can be scheduled for release to the seller's account. See the Resolution Case Management API User Guide for information about retrieving and managing eBay Buyer Protection cases.

•   ResolvePPPIcase

(out) This value indicates that the seller must resolve the PayPal Buyer Protection case filed against the order line item to expedite the release of funds into their account.

•   ResolveReturn

(out) This value indicates that the buyer is returning the item through eBay's managed return process. Upon receiving the returned item from the buyer, the seller must issue a refund to the buyer within five business days, and shortly after this happens, eBay will credit the seller's account with the Final Value Fee that was originally assessed on the sale of the item.

•   UploadTrackingInfo

(out) This value indicates that the seller must provide the buyer the tracking information for the order line item to expedite the release of funds into their account. The seller can use the CompleteSale call to provide tracking information for an order line item. If the tracking information for an order line item is provided, it is possible that the seller's funds for the order will be released as soon as three days after eBay has confirmed that the item has been delivered.




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

Applicable values:

•   CustomCode

(out) This value is reserved for internal or future use.

•   MerchantHold

(out) This value indicates a possible issue with a seller. If this value is returned, the TransactionArray.Transaction.SellerPaidStatus field is returned as PaidWithPayPal in GetMyeBaySelling, and the TransactionArray.Transaction.BuyerPaidStatus field is returned as PaidWithPayPal in GetMyeBayBuying.

•   NewSellerHold

(out) This value indicates that there is a "new seller hold" on the item. PayPal may hold payments to a new seller for up to 21 days. Sellers are considered "new" until they have met all three criteria below:

  • More than 90 days have passed since first successful sale
  • More than 25 domestic sales
  • More than $250.00 in total sales

•   None

(out) This value indicates that there is no payment hold on the item.

•   PaymentHold

(out) This value indicates that there is a payment hold on the item.

•   PaymentReview

(out) This value indicates a possible issue with a buyer. If this value is returned, the TransactionArray.Transaction.SellerPaidStatus field is returned as NotPaid in GetMyeBaySelling, and the TransactionArray.Transaction.BuyerPaidStatus field is returned as PaidWithPayPal in GetMyeBayBuying.

•   ReleaseConfirmed

(out) This value indicates that the funds are available in the seller's PayPal account.

•   Released

(out) This value indicates that a payment hold on the item has been released.

•   ReleasePending

(out) This value indicates that the process for the release of funds for the order has been initiated.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .PaymentMethods 		BuyerPaymentMethodCodeType Always,
repeatable: [1..*]		 This field indicates a payment method available to the buyer to pay for the order. There can be multiple PaymentMethods fields.

For DE and AT orders subject to the new eBay payment process, only one PaymentMethods field will be returned, and the value will always be 'StandardPayment'.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.

Applicable to Half.com (for GetOrders).

Applicable values: See PaymentMethods.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.RefundArray RefundArrayType Conditionally Container consisting of one or more refunds for Half.com orders or DE/AT orders subject to the new eBay payment process. This container is returned only if a refund to a Half.com buyer has occurred or a refund was issued for an order subject to the new eBay payment Process.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.


DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.RefundArray
  .Refund 		RefundType Conditionally,
repeatable: [0..*]		 Contains information about one refund. Applicable to Half.com (for GetOrders). Applicable to refunds issued with eBay's new Payment Process.

Note: The new eBay payment process for German and Austrian sites has been put on hold indefinitely.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.RefundArray
  .Refund
  .EstimatedRefundCompletionTime 		dateTime Conditionally The estimated date and time that the refund is expected to be completed. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.RefundArray
  .Refund.ExternalReferenceID 		string Conditionally The unique external reference ID that was passed by the seller when requesting the refund. This ID helps to prevent duplication of refund requests. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.RefundArray
  .Refund.RefundAmount 		AmountType (double) Conditionally The total amount of the refund requested. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.RefundArray
  .Refund.RefundCompletionTime 		dateTime Conditionally The date and time that the refund was completed. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.RefundArray
  .Refund.RefundFailureReason 		RefundFailureReasonType Conditionally This describes the reason why a refund was not issued by the seller. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.RefundArray
  .Refund.RefundFailureReason
  .RefundFailureCode 		RefundFailureCodeType Conditionally An enumerated value indicating the reason why a German or Austrian seller's attempt to distribute a refund to a buyer through the Order Adjustment API's issueRefund call failed. This field is only applicable to orders subject to the new eBay payment process on the German and Austrian sites.

Note: The new eBay payment process for German and Austrian sites has been put on hold indefinitely.

Applicable values:

•   PaypalBillingAgreementCanceled

(out) The refund attempt failed because the seller's billing agreement with PayPal has been cancelled.

Note: The new eBay payment process for German and Austrian sites has been put on hold indefinitely.

•   PaypalRiskDeclinesTransaction

(out) The refund attempt failed because because the PayPayl Risk team declined the transaction. The seller should log in to their PayPal account to proceed with the refund request.

Note: The new eBay payment process for German and Austrian sites has been put on hold indefinitely.


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


DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.RefundArray
  .Refund
  .RefundFundingSourceArray 		RefundFundingSourceArrayType Conditionally This container lists the funding sources for the refund. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.RefundArray
  .Refund
  .RefundFundingSourceArray
  .RefundFundingSource 		RefundFundingSourceType Conditionally,
repeatable: [0..*]		 The funding source for the refund issued by the seller through the Order Adjusment API's issueRefund call. It is possible that more than one funding source may be used for this refund.

Note: The new eBay payment process on the German and Austrian sites has been put on hold indefinitely.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.RefundArray
  .Refund
  .RefundFundingSourceArray
  .RefundFundingSource
  .AccountNumber 		string Conditionally The account number of the funding source.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.RefundArray
  .Refund
  .RefundFundingSourceArray
  .RefundFundingSource
  .BuyerExternalTransactionID 		string Conditionally The external transaction ID of the buyer's account.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.RefundArray
  .Refund
  .RefundFundingSourceArray
  .RefundFundingSource
  .RefundAmount 		AmountType (double) Conditionally The amount of the refund.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.RefundArray
  .Refund
  .RefundFundingSourceArray
  .RefundFundingSource
  .RefundingSourceType 		RefundingSourceTypeCodeType Conditionally The source from which the refund was made.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

Applicable values:

•   BankAccount

(out) The seller's bank account associated with the transaction.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

•   CustomCode

(out) Reserved for internal or future use.

•   Paypal

(out) The seller's PayPal account associated with the transaction.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

•   ScheduledPayout

(out) The seller's scheduled payout account with eBay. When a buyer pays for an item the purchase amount goes into this account. This value indicates that the refund has been issued from the seller's scheduled payout account.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.RefundArray
  .Refund
  .RefundFundingSourceArray
  .RefundFundingSource
  .SellerExternalTransactionID 		string Conditionally The external transaction ID of the seller's account.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.RefundArray
  .Refund.RefundID 		string Conditionally The refund ID for this refund. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.


Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.RefundArray
  .Refund.RefundRequestedTime 		dateTime Conditionally The date and time when the refund was requested. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.RefundArray
  .Refund.RefundStatus 		RefundStatusCodeType Conditionally A code indicating the status of the refund request. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Failed

(out) The refund request was rejected.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

•   Pending

(out) The refund request is being processed.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

•   Successful

(out) The refund request was successful.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.RefundArray
  .Refund.RefundTransactionArray 		RefundTransactionArrayType Conditionally A container consisting of details about an order line item against which the seller issued a refund. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.RefundArray
  .Refund.RefundTransactionArray
  .RefundTransaction 		RefundTransactionType Conditionally,
repeatable: [0..*]		 A container consisting of details about an order line item against which the seller issued a refund.

Note: The new eBay payment process on the German and Austrian sites has been put on hold indefinitely.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.RefundArray
  .Refund.RefundTransactionArray
  .RefundTransaction.ItemID 		string Conditionally The item against which the refund was issued. This value must be accompanied by a TransactionID value.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.RefundArray
  .Refund.RefundTransactionArray
  .RefundTransaction.OrderID 		string Conditionally The order against which the refund was issued. The presence of this value indicates that the refund was issued against the entire order.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.RefundArray
  .Refund.RefundTransactionArray
  .RefundTransaction
  .RefundLineArray 		RefundLineArrayType Conditionally An array of refund lines identifying the order line items against which the refund was issued.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.RefundArray
  .Refund.RefundTransactionArray
  .RefundTransaction
  .RefundLineArray.RefundLine 		RefundLineType (AmountType) Conditionally,
repeatable: [0..*]		 This field indicates the type and amount of the refund to the buyer involved in an DE/AT order order subject to the new eBay payment process. The type attribute indicates whether the refund is being applied against the purchase price or the shipping price. Using the issueRefund call of the Order Adjustment API, the seller can also issue an optional/additional refund that does not apply to the purchase price or shipping price. The type values are defined in the RefundLineTypeCodeType enumeration type.



RefundLine fields will only be returned if a refund has been issued from the seller to the buyer for a DE/AT order going through the new eBay payment process.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.RefundArray
  .Refund.RefundTransactionArray
  .RefundTransaction
  .RefundLineArray.RefundLine
  [ attribute type ]		 RefundLineTypeCodeType Conditionally A code indicating the order line item to which the refund was applied.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

For a list of possible enumeration values, see RefundLineTypeCodeType.
OrderArray.Order.RefundArray
  .Refund.RefundTransactionArray
  .RefundTransaction
  .TransactionID 		string Conditionally The transaction against which the refund was issued. This value must be accompanied by an ItemID value.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.RefundArray
  .Refund.SellerNoteToBuyer 		string Conditionally Comments made by the the seller to the buyer. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.ShippedTime dateTime Conditionally Timestamp indicating the date and time of order shipment. This field is not returned until the order has been marked as shipped. Note that sellers have the ability to set the shipped time up to three calendar days in the future.

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.

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingAddress 		AddressType Always Container holding the shipping address of the buyer involved in the order.

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingAddress.AddressID 		string Conditionally Unique ID for a user's address in the eBay database. This value can help prevent the need to store an address multiple times across multiple orders. The ID changes if a user changes their address.

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

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   DefaultShipping

(out) This is default shipping address which is rendered to buyer on checkout.

•   Invalid

(out) This is not a valid address. Please use another address.

•   Shipping

(out) This is an address which is in user's address book. It can be used at the time of checkout.




DetailLevel: 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: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. .

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingAddress.Country 		CountryCodeType Conditionally The two-digit code representing the country 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.

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

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

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingAddress
  .ExternalAddressID 		string Conditionally ID assigned to the address by the address owner, e.g. by the PayPal system. Currently, the ExternalAddressID only applies for a customer address in the PayPal system. The ID changes if a user changes their address. Also see the AddressOwner field. The ExternalAddressID value also is 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: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. .

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

In the US, the area code (3 digits), the prefix (3 digits), the line number (4 digits), and phone extension (if specified by the user) are returned in this field. The extension can be one or more digits. Non-breaking spaces are used as delimiters between these phone number components.

Also applicable to Half.com (for GetOrders).
Max length: eBay validates the content (should only be integer values and delimiters), but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. .

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

For a Global Shipping Program order, GetSellerList and GetMyeBaySelling return the postal code of the buyer, not that of the international shipping provider.

Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 9 (not counting delimiter characters) for the US. Note: The eBay database allocates up to 24 characters for this field. .

DetailLevel: 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: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. .

DetailLevel: 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: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. .

DetailLevel: 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: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. .

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingDetails 		ShippingDetailsType Always Container consisting of all shipping-related details for an order, including domestic and international shipping service options, shipment tracking information, and shipping insurance information.

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingDetails
  .AllowPaymentEdit 		boolean Conditionally This field is no longer returned and has been replaced by the ShippingDetails.PaymentEdited field.

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 an order). Valid 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.CODCost 		AmountType (double) Conditionally This dollar value indicates the money due from the buyer upon delivery of the item.

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

This field is only returned if set for the listing.

To see if 'COD' is a supported payment method for a site, call GeteBayDetails with the DetailName field set to 'PaymentOptionDetails'. Look for a value of 'COD' in one of the PaymentOptionDetails.PaymentOption fields in the response.

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

See Other Shipping Features.
OrderArray.Order
  .ShippingDetails
  .ExcludeShipToLocation 		string Conditionally,
repeatable: [0..*]		 Use this field to specify an international country or region, or a special domestic location, such as 'PO Box' (in US) or 'Packstation' (in DE), to where you will not ship the associated item. Repeat this element in the call request for each location that you want to exclude as a shipping destination for your item.

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

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

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

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

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

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

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

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

Applicable values: See CountryCodeType, ShippingRegionCodeType
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: 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 only returned if the value is other than NotOffered.

Valid only on the following sites: 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: 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.

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

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

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

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

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
  .ImportCharge 		AmountType (double) Conditionally The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
Min: 0.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingDetails
  .InternationalShippingServiceOption
  .ImportCharge
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests 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.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
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 Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests 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.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingService 		token Conditionally An international shipping service being offered by the seller to ship an item to a buyer. For a list of valid values, call GeteBayDetails with DetailName set to ShippingServiceDetails. To view the full list of International shipping service options in the response, look for the ShippingService fields in the ShippingServiceDetails containers that contain a InternationalService=true field, as this indicates that the ShippingService value is an International shipping service option. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.

For flat and calculated shipping.

DetailLevel: 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 The cost of shipping each additional item beyond the first item. For input, this is required if the listing is for multiple items. For single-item listings, it should be zero (or is defaulted to zero if not provided). 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 Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests 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.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

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.

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

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

See Shipping.
OrderArray.Order
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests 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.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServicePriority 		int Conditionally This integer value controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page. Sellers can specify up to five international shipping services (with five InternationalShippingServiceOption containers), so valid values are 1, 2, 3, 4, and 5. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 5 appears at the bottom of a list of five shipping service options.

This field is applicable to Flat and Calculated shipping. This field is not applicable to Half.com listings.

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 with DetailName set to ShippingLocationDetails to determine which locations are valid per site. In the GeteBayDetails response, look for the ShippingLocationDetails.ShippingLocation fields. For the AddItem family of calls, this field is required if any international shipping service is specified.

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

See Specifying Locations to Where You Ship.



Applicable values: See CountryCodeType, ShippingRegionCodeType
OrderArray.Order
  .ShippingDetails.SalesTax 		SalesTaxType Always Sales tax details. US (site 0) and Motors (site 100) sites only, excluding vehicle listings. Flat and calculated shipping.

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 The amount of sales tax, calculated for an order based on the SalesTaxPercent and pricing information. US (site 0) and Motors (site 100) sites only, excluding vehicle listings.

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

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

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

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 a single or a multiple line item order.
Applicable to Half.com (for GetOrders).

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

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

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


DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingDetails
  .ShipmentTrackingDetails
  .ShipmentTrackingNumber 		string Conditionally Required if ShippingCarrierUsed is supplied. The tracking number assigned by the shipping carrier to the item shipment. The format of the tracking number must be consistent with the format used by the specified shipping carrier (ShippingCarrierUsed). Typically, you should avoid spaces and hyphens. Returned only if set. Returned for Half.com as well.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingDetails
  .ShipmentTrackingDetails
  .ShippingCarrierUsed 		string Conditionally Required if ShipmentTrackingNumber is supplied. Name of the shipping carrier used to ship the item. Although this value can be any value, since it is not checked by eBay, commonly used shipping carriers can be found by calling GeteBayDetails with DetailName set to ShippingCarrierDetails and examining the returned ShippingCarrierCodeTypes.

For those using UPS Mail Innovations, supply the value UPS-MI for UPS Mail Innnovations. Buyers will subsequently be sent to the UPS Mail Innovations website for tracking.

For those using FedEx SmartPost in a CompleteSale callsupply the value FedEx. Buyers will subsequently be sent to the appropriate web site for tracking status. (The buyer is sent to the UPS Mail Innovations website if UPS-MI is specified, or to the FedEx website if FedEx is specified.) Returned only if set. Returned for Half.com as well.

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

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

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

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

A seller can offer up to four domestic shipping services and up to five international shipping services. All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated).

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

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
  .ImportCharge 		AmountType (double) Conditionally The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
Min: 0.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ImportCharge
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests 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.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
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 Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests 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.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingService 		token Conditionally A shipping service option being offered by the seller to ship an item to a buyer. For a list of valid ShippingService values, GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.

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

For flat and calculated shipping. 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. For single-item listings, it should be zero (or is defaulted to zero if not provided). 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 Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests 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.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

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.

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

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

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

For GetMyeBaySelling, ShippingServiceCost under the SoldList and DeletedFromSoldList containers returns the cost of the domestic leg of a Global Shipping Program shipment (to the international shipping provider's warehouse).

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 Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests 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.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServicePriority 		int Conditionally This integer value controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page. Sellers can specify up to four domestic shipping services (with four ShippingServiceOptions containers), so valid values are 1, 2, 3, and 4. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 4 appears at the bottom of a list of four shipping service options.

This field is applicable to Flat and Calculated shipping. This field is not applicable to Half.com listings.

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 have the item shipped via UPS or FedEx to Alaska, Hawaii or Puerto Rico. Can only be assigned a value for the eBay US site and for items in the Parts and Accessories category of the eBay Motors site. Only returned if set. If some line items in an order have a surcharge, surcharge is added only for those line items. Flat rate shipping only.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingSurcharge
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests 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.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

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 Container consisting of details about the domestic or international shipping service selected by the buyer.

Note: For GetOrders and GetOrderTransactions, if you provide OrderLineItemID values in the OrderID field, this container does not return accurate shipping service and cost information for multiple line item orders. You must provide the order's combined OrderID value to ensure that the ShippingService and ShippingServiceCost fields return the correct values for the order.

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
  .ImportCharge 		AmountType (double) Conditionally The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
Min: 0.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingServiceSelected
  .ImportCharge
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests 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.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
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 Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests 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.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingServiceSelected
  .ShippingService 		token Conditionally A shipping service option being offered by the seller to ship an item to a buyer. For a list of valid ShippingService values, GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.

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

For flat and calculated shipping. 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. For single-item listings, it should be zero (or is defaulted to zero if not provided). 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 Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests 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.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

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.

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

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

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

For GetMyeBaySelling, ShippingServiceCost under the SoldList and DeletedFromSoldList containers returns the cost of the domestic leg of a Global Shipping Program shipment (to the international shipping provider's warehouse).

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 Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests 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.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingServiceSelected
  .ShippingServicePriority 		int Conditionally This integer value controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page. Sellers can specify up to four domestic shipping services (with four ShippingServiceOptions containers), so valid values are 1, 2, 3, and 4. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 4 appears at the bottom of a list of four shipping service options.

This field is applicable to Flat and Calculated shipping. This field is not applicable to Half.com listings.

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 have the item shipped via UPS or FedEx to Alaska, Hawaii or Puerto Rico. Can only be assigned a value for the eBay US site and for items in the Parts and Accessories category of the eBay Motors site. Only returned if set. If some line items in an order have a surcharge, surcharge is added only for those line items. Flat rate shipping only.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .ShippingServiceSelected
  .ShippingSurcharge
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests 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.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order.Subtotal AmountType (double) Always The subtotal amount for the order is the total cost of all order line items. This value does not include any shipping/handling, shipping insurance, or sales tax costs.

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.Total AmountType (double) Always The Total amount equals the Subtotal value plus the shipping/handling, shipping insurance, and sales tax costs.

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray 		TransactionArrayType Always Container consisting of one or more line items that comprise an order. The data for an order line item is stored in the Transaction container. For the AddOrder call, there will always be at least two order line items in the container, but no more than 40.

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

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction 		TransactionType Always,
repeatable: [1..*]		 The Transaction container consists of detailed information on one order line item. Also applicable to Half.com (for GetOrders).

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

See Listing an Item.
OrderArray.Order
  .TransactionArray.Transaction
  .ActualHandlingCost 		AmountType (double) Always The handling cost for the order line item. The value of this field is returned as zero dollars if the seller did not specify a handling cost for the listing. It also will show as 0.00 dollars until payment has been made on the order.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .ActualShippingCost 		AmountType (double) Always The shipping cost charged to the buyer for the order line item.

For GetOrders, this field is returned only after checkout is completed on the order. A value of 0.00 indicates free shipping.

For other calls, this field is always returned but defaults to 0.00 until payment has been made on the order.

Note: This is different from the field of the same name returned by GetSellingManagerSaleRecord and ReviseSellingManagerSaleRecord, which contains the actual shipping cost paid by the seller.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .AdjustmentAmount 		AmountType (double) Conditionally This value indicates the dollar amount by which the buyer has adjusted the order total. Adjustments to order costs may include shipping and handling, shipping insurance, buyer discounts, or added services. A positive amount indicates the amount is an extra charge being paid to the seller by the buyer. A negative value indicates this amount is a credit given to the buyer by the seller.

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 This value indicates the total amount of the line item. This amount includes the sale price, shipping and handling charges, shipping insurance (if offered and selected by the buyer), additional services, and any applied sales tax. This value is returned after the buyer has completed checkout (the CheckoutStatus.Status output field reads "Complete"). If the seller allowed the buyer to change the total for an order, the buyer is able to change the total up until the time when checkout status is Complete. Determine whether the buyer changed the amount by retrieving the order line item data and comparing the AmountPaid value to what the seller expected. If multiple order line items between the same buyer and seller have been combined into a Combined Payment order, the AmountPaid value returned in GetSellerTransactions and GetItemTransactions reflects the amount paid for the Combined Payment order and not the individual order line item. You can determine the order line items that belong to the same Combined Payment order by checking to see if the ContainingOrder.OrderID value is the same. For Motors items, AmountPaid is the amount paid by the buyer for the deposit.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .BestOfferSale 		boolean Conditionally Indicates whether or not the order line item was created as the result of the seller accepting a Best Offer from a buyer.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer 		UserType Conditionally UserType container consisting of eBay user data for the buyer. See UserType for its child elements. Returned by GetItemsAwaitingFeedback if the 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.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.

DetailLevel: ReturnAll.

See Working with Anonymous User Information.
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer.Email 		string Conditionally Email address for the user. Please see the links below to the topics related to anonymous user information and static email addresses. You cannot retrieve an email address for any user with whom you do not have an order relationship, regardless of site. An email address of another user is only returned if you and the other user are in an order relationship, within a certain time of order line item creation (although this limitation isn't applicable to the GetAllBidders call in the case of motor vehicles categories.) Based on Trust and Safety policies, the time is unspecified and can vary by site.

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

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

DetailLevel: ReturnAll.

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

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.

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 either side of an order. Each order line item can result in one feedback entry for a given user (the buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). If the user has chosen to make their feedback private and that user is not the user identified in the request's authentication token, FeedbackScore is not returned and FeedbackPrivate is returned with a value of true.

In GetMyeBayBuying and GetMyeBaySelling, feedback information (FeedbackScore and FeedbackRatingStar) is returned in BidList.ItemArray.Item.Seller. For GetMyeBayBuying, the feedback score of each seller with an item having received a bid from the buyer is returned. For GetMyeBaySelling, the feedback score of the seller is returned.

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

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

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.StaticAlias 		string Conditionally Contains the static email address of an eBay member, used within the "reply to" email address when the eBay member sends a message. (Each eBay member is assigned a static alias. The alias is used within a static email address.)

DetailLevel: ReturnAll.

See Static Email Addresses in Trading API Calls.
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 needs to complete verification of credit card information. A user has this status if this user began registration as a seller but did not complete it. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)

•   CreditCardVerifyHalfOptIn

(out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the user needs to complete verification of credit card information. A user has this status on eBay if this user began registration as a seller but did not complete it. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)

•   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. Or, if this user began registration as a seller but did not complete it, the user will have this status. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)

•   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, 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 can change for each auction.

For GetMyeBayBuying only, when bidding on items: UserID is replaced with the value "a****b" where a and b are random characters from the UserID.

When bidding on items listed on the the Philippines site: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3.

Note that in this Philippines site format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3".

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

For PlaceOffer, see also SellingStatus.HighBidder.

DetailLevel: ReturnAll.

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 Value-Added Tax (VAT).
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 Unique identifier for an instance of Shopping.com shopping cart. This field is only returned for Shopping.com order line items (transactions).
Max length: 10.

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

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 This value indicates the converted value of AmountPaid in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates.

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 This value indicates the converted value of TransactionPrice in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates.

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 the creation time of the order line item. For auction listings, an order line item is created when that listing ends with a high bidder whose bid meets or exceeds the Reserve Price (if set). For a fixed-price listing or a Buy It Now auction listing, an order line item is created once the buyer clicks the Buy button.

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 This value indicates whether or not the seller requires a deposit for the vehicle. This field is only applicable to US eBay Motors Vehicle listings. Otherwise, this field is returned as an empty value.

Not applicable to Half.com.

Applicable values:

•   None

(in/out) No deposit needed.

•   OtherMethod

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


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


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

See Listing US and CA eBay Motors Items.
OrderArray.Order
  .TransactionArray.Transaction
  .ExternalTransaction 		ExternalTransactionType Conditionally,
repeatable: [0..*]		 Container consisting of details for the electronic payment of an eBay order line item. PayPal transactions may include a buyer payment or refund, or a fee or credit applied to the seller's account. This field is only returned after payment for the order line item has occurred.

For orders in which the seller's funds are being held by PayPal,the PaymentHoldDetails container and PaymentHoldStatus field will be returned instead of the ExternalTransaction container.

Note: In an upcoming release, ExternalTransaction will be replaced by the more versatile MonetaryDetails container, so you are encouraged to start using MonetaryDetails now. Not applicable to Half.com.

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

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Failed

(out) The payment has been processed, but was not received by the payee.

•   Pending

(out) Payment has been initiated and is being processed.

•   Succeeded

(out) The payment was received by the payee.




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

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

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

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

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

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

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .IntangibleItem 		boolean Conditionally This flag indicates whether or not the order line item is an intangible good such as an MP3 track or a mobile phone ringtone. Intangible items are not eligible for PayPal's Seller Protection program, so the seller will not be able to open an Unpaid Item case against the buyer.

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

DetailLevel: ReturnAll.
OrderArray.Order
  .TransactionArray.Transaction
  .IsMultiLegShipping 		boolean Conditionally If IsMultilegShipping is true, the order or transaction uses the Global Shipping Program, in which the shipment has a domestic leg and an international leg. The buyer's shipping address is in a country other than the country where the items were listed, and the Get family of calls will return InternationalPriorityShipping as the default international shipping service in the listings of all the items in the order.

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

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Item 		ItemType Always Container consisting of details about an item in a listing. The child fields returned are dependent on the call, the type of item or listing, and the listing site.

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 To create a requirement that a buyer pays immediately (through PayPal) for an auction (Buy It Now only) or fixed-price item, the seller can include and set the AutoPay field to 'true' for an Add/Revise/Relist/VerifyAdd API call. If the seller does not want to create an immediate payment item, this field is either omitted, or included and set to 'false'.

If this feature is enabled for a listing, the buyer must pay immediately for the item through PayPal, and the buyer's funds are transferred instantly to the seller's PayPal account. The seller's item will remain available for purchase by other buyers until the buyer actually completes the payment.

In order for a seller to apply an immediate payment requirement for an item, the following must be true:
  • seller must have a Premier or Business PayPal account;
  • the Buy It Now price (if applicable) cannot be higher than $10,000 USD;
  • the listing site supports PayPal payments;
  • the category supports PayPal payments;
  • the listing type is fixed-price or auction (with Buy It Now option).

To successfully enable the immediate payment requirement, the seller must also perform the following actions through the API call:
  • seller must provide a valid Item.PayPalEmailAddress value;
  • seller must offer PayPal as the only payment method;
  • seller must specify all related costs to the buyer, since the buyer will not be able to use the Buyer Request Total feature in an immediate payment listing; these costs include flat-rate shipping costs for each domestic and international shipping service offered, package handling costs, and any shipping surcharges;
  • seller must include and set the PromotionalShippingDiscount field to true if a promotional shipping discount is being applied to the listing;
  • seller must include the ShippingDiscountProfileID and reference a valid flat or calculated Shipping Discount Profile ID if a flat or calculated shipping rule is being applied to the listing.

In the Trading API calls that return the AutoPay field, be aware that the field's appearance in the output does not necessarily indicate that the immediate payment feature was successfully enabled/used for the active or ended listing, but only that the seller attempted to enable (by including and setting AutoPay to 'true' in the request) the immediate payment feature for the listing.

To discover if a category supports immediate payment for an item, use GetCategories and look for the appearance of the AutoPayEnabled boolean field in the output for that category (identified by CategoryID). AutoPayEnabled is returned as an empty element if the category supports immediate payment, and is not returned at all if the category does not support immediate payment.

Not applicable to Half.com.

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

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

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

Not applicable to Half.com.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   ItemEligible

(out) This value indicates that the item is eligible for buyer protection.

•   ItemIneligible

(out) This value indicates that the item is ineligible for buyer protection. In many cases, the item is ineligible for buyer protection due to the category it is listed under.

•   ItemMarkedEligible

(out) This value indicates that the eBay customer support has marked the item as eligible per special criteria.

•   ItemMarkedIneligible

(out) This value indicates that the eBay customer support has marked the item as ineligible per special criteria (e.g., seller's account closed).

•   NoCoverage

(out) This value indicates that the item is ineligible for coverage under any buyer protection program.




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 auction listings, the Buy It Now feature allows a user to purchase the item at a Buy It Now price and end the auction immediately. Use this field to specify the Buy It Now price. Including and specifying a BuyItNowPrice value enables the Buy It Now feature for the auction listing.

There is a minimum percentage value that the Buy It Now price must be set above the Start Price. This minimum percentage value varies by site. To see the valid values for your site, call GeteBayDetails with DetailName set to ListingStartPriceDetails, and then look for the ListingStartPriceDetails.MinBuyItNowPricePercent field in the response. If this value is 40.0 (percent), that means that your Buy It Now price on your auction listing must exceed the Start Price by 40 percent to be valid.

This feature is not applicable to fixed-price listings, Ad Format listings, or Half.com listings.

Once an 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 still return the BuyItNowPrice that the seller originally set for the listing. Use the GetItem call and look for the inclusion of the Item.ListingDetails.BuyItNowAvailable flag in the output to determine whether the item can still be purchased using Buy It Now. You can also view the Item.SellingStatus.BidCount value in other item retrieval calls to determine whether an auction with Buy It Now has bids or not.

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:
    Listing Policies
    Revising Items

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.

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 identifier assigned to a nonprofit charity organization by the dedicated provider of eBay Giving Works. This value can contain up to 10 digits. This value is superseded by CharityID.

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 committed to the GetItFast shipping rules for this listing. If the GetItFast field is set to true, and the seller's first priority domestic shipping service (the service that has the ShippingServicePriority field set to 1) is an expedited shipping service, then every shipping service offered for this listing is considered a GetItFast service. Therefore, 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 order retrieval calls (such as, GetOrders), use the OrderLineItemID (which is a concatenation of ItemID and TransactionID to uniquely identify an order line item. 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.
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 auction style or fixed price.

Optional for eBay.com listings (defaults to auction style) 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 in 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.

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

•   LeadGeneration

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

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


(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
    Basic Building Blocks
    GetCategoryFeatures
    Fees per Site

OrderArray.Order
  .TransactionArray.Transaction
  .Item.PrivateListing 		boolean Always The PrivateListing boolean field can be used by the seller in the Add/Relist/Revise family of calls to obscure item title, item ID, and item price from post-order Feedback comments left by buyers. Typically, it is not advisable that sellers use the Private Listing feature, but using this feature may be appropriate for sellers listing in Adults Only categories, or for high-priced and/or celebrity items.

For GetItem, order retrieval calls, and other calls that retrieve the Item object, the PrivateListing field is only returned if 'true'.

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 The current price of the item in the original listing currency.

For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price.

For fixed-price and ad format listings, this is the current listing price.

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

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Item.SellingStatus
  .FinalValueFee 		AmountType (double) Conditionally A seller is changed a Final Value Fee (FVF) when the item is sold, ends with a winning bid, or is purchased. This fee applies whether or not the sale is completed with the buyer and is generated before the buyer makes a payment.

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

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

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

Not applicable to Half.com.

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.

•   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
  .MonetaryDetails 		PaymentsInformationType Conditionally Contains information about how funds exchanged for an order are allocated to payees.

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

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

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Payments 		PaymentInformationType Conditionally Contains information about how different portions of the funds exchanged for a specified order are allocated among payees. Each allocated portion is represented by a Payment container.

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

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

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

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.Payee 		UserIdentityType (string) Conditionally The person or organization who is to receive the payment allocation.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.Payee
  [ attribute type ]		 UserIdentityCodeType Conditionally Type of user involved in an exchange of funds for an order.

For a list of possible enumeration values, see UserIdentityCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.Payer 		UserIdentityType (string) Conditionally The person or organization who submitted the payment.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.Payer
  [ attribute type ]		 UserIdentityCodeType Conditionally Type of user involved in an exchange of funds for an order.

For a list of possible enumeration values, see UserIdentityCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.PaymentAmount 		AmountType (double) Conditionally The amount of the payment that is allocated to the payee.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.PaymentStatus 		PaymentTransactionStatusCodeType Conditionally The current status of a buyer payment that is allocated to a specified payee.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Failed

(out) The payment has been processed, but was not received by the payee.

•   Pending

(out) Payment has been initiated and is being processed.

•   Succeeded

(out) The payment was received by the payee.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.PaymentTime 		dateTime Conditionally The date and time when the payment is received by the payee.

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

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

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.ReferenceID
  [ attribute type ]		 TransactionReferenceCodeType Conditionally The type of transaction ID for this payment.

For a list of possible enumeration values, see TransactionReferenceCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .OrderLineItemID 		string Always A unique identifier for an eBay order line item. This field is created as soon as there is a commitment to buy from the seller, and its value is based upon the concatenation of ItemID and TransactionID, with a hyphen in between these two IDs.
Max length: 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.).
OrderArray.Order
  .TransactionArray.Transaction
  .PaymentHoldDetails 		PaymentHoldDetailType Conditionally This container consists of information related to the payment hold on the order line item, including the reason why the buyer's payment for the order line item is being held, the expected release date of the funds into the seller's account, and possible action(s) the seller can take to expedite the payout of funds into their account. This container is only returned if PayPal has placed a payment hold on the order line item.

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

DetailLevel: ReturnAll.
OrderArray.Order
  .TransactionArray.Transaction
  .PaymentHoldDetails
  .ExpectedReleaseDate 		dateTime Always Timestamp that indicates the expected date in which eBay/PayPal will distribute the funds to the seller's account. This is not a firm date and is subject to change.

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

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

Applicable values:

•   BelowStandardSeller

(out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller has been classified as a Below Standard seller.

•   CasualSeller

(out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller is classified as a casual seller on eBay.

•   CustomCode

(out) This value is reserved for internal or future use.

•   EbpCaseOpen

(out) This value indicates that the buyer's payment for the order is being held by PayPal because an eBay Buyer Protection case has been filed against the order. If this value is returned, the seller can expedite the release of PayPal funds into their account by resolving the eBay Buyer Protection case, as indicated by a value of 'ResolveeBPCase' returned in a PaymentHoldDetails.RequiredSellerActionArray.RequiredSellerAction field.

•   NewPaypalAccountAdded

(out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller's PayPal account (identified in Transaction.PayPalEmailAddress) is new and is not fully set up to receive funds.

•   NewSeller

(out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller is new to selling on eBay. Sellers are considered "new" until they have met all three criteria below:

  • More than 90 days have passed since first successful sale
  • More than 25 domestic sales
  • More than $250.00 in total sales

•   NotAvailable

(out) This value indicates that the reason for the buyer's payment for the order being held by PayPal is not known.

•   Other

(out) This value is returned if the reason for the buyer's payment for the order being held by PayPal cannot be classified by any of the other enumeration values.

•   ReinstatementAfterSuspension

(out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller has recently been reinstated as an active eBay seller after their account went through a suspension/restricted period.

After a seller's account is suspended and then reinstated, that seller is treated as a new seller, and must meet the same requirements that a new seller must meet to get beyong the "New Seller" status.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .PaymentHoldDetails
  .RequiredSellerActionArray 		RequiredSellerActionArrayType Always Container consisting of one or more RequiredSellerAction fields. RequiredSellerAction fields provide possible actions that a seller can take to expedite the release of funds into their account.

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

Applicable values:

•   ContacteBayCS

(out) This value indicates that the seller should contact eBay Customer Support to discover the next required action to expedite the release of funds into their account.

•   CustomCode

(out) This value is reserved for internal or future use.

•   MarkAsShipped

(out) This value indicates that the seller must mark the order line item as shipped to expedite the release of funds into their account. The seller can use the CompleteSale call to mark an item as shipped. If an order line item is marked as shipped, it is possible that the seller's funds for the order will be released as soon as seven days after the latest estimated delivery date.

•   None

(out) This value is not currently applicable since the new eBay Payment Process for DE and AT sellers has been rolled back indefinitely.

•   ResolveBuyerMessageInr

(out) This value indicates that the buyer has not received the item, and the buyer has contacted the seller through the eBay system in an effort to resolve the issue with the seller. The seller must make it right with the buyer in order to expedite the release of funds into their account.

•   ResolveBuyerMessageSnad

(out) This value indicates that the buyer has received the item, but the item is not as described in the listing; hence, the buyer has contacted the seller through the eBay system in an effort to resolve the issue with the seller. The seller must make it right with the buyer in order to expedite the release of funds into their account.

•   ResolveeBPCase

(out) This value indicates that there is an open eBay Buyer Protection case involving the seller and the item. The seller must address and get the case resolved before the funds can be scheduled for release to the seller's account. See the Resolution Case Management API User Guide for information about retrieving and managing eBay Buyer Protection cases.

•   ResolvePPPIcase

(out) This value indicates that the seller must resolve the PayPal Buyer Protection case filed against the order line item to expedite the release of funds into their account.

•   ResolveReturn

(out) This value indicates that the buyer is returning the item through eBay's managed return process. Upon receiving the returned item from the buyer, the seller must issue a refund to the buyer within five business days, and shortly after this happens, eBay will credit the seller's account with the Final Value Fee that was originally assessed on the sale of the item.

•   UploadTrackingInfo

(out) This value indicates that the seller must provide the buyer the tracking information for the order line item to expedite the release of funds into their account. The seller can use the CompleteSale call to provide tracking information for an order line item. If the tracking information for an order line item is provided, it is possible that the seller's funds for the order will be released as soon as three days after eBay has confirmed that the item has been delivered.




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. This value is only revealed if it is the seller making the call.

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

Applicable values:

•   CustomCode

(in/out) Reserved for future use.

•   eBay

(in/out) The order line item was created on the main eBay site.

•   Express

(in/out) The order line item was created on the eBay Express site.

•   Half

(in/out) The order line item was created on Half.com site.

•   Shopping

(in/out) The order line item was created on the Shopping.com site.

•   WorldOfGood

(in/out) The order line item was created on the WorldOfGood site.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .QuantityPurchased 		int Conditionally This value indicates the number of identical items purchased at the same time by the same buyer from one listing. For auction listings, this value is always 1. For fixed-price, non-variation listings, this value can be greater than 1. In either case, this field is tied to the same order line item.

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray 		RefundArrayType Conditionally Container consisting of one or more refund transactions to Half.com buyers. Container consisting of one or more refund transactions for eBay's new payment process. This container is only returned if a refund to a Half.com buyer has occurred or an refund was issued through eBay's new payment process

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund 		RefundType Conditionally,
repeatable: [0..*]		 Contains information about one refund. Applicable to Half.com (for GetOrders). Applicable to refunds issued with eBay's new Payment Process.

Note: The new eBay payment process for German and Austrian sites has been put on hold indefinitely.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund
  .EstimatedRefundCompletionTime 		dateTime Conditionally The estimated date and time that the refund is expected to be completed. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund
  .ExternalReferenceID 		string Conditionally The unique external reference ID that was passed by the seller when requesting the refund. This ID helps to prevent duplication of refund requests. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund
  .RefundAmount 		AmountType (double) Conditionally The total amount of the refund requested. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund
  .RefundCompletionTime 		dateTime Conditionally The date and time that the refund was completed. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund
  .RefundFailureReason 		RefundFailureReasonType Conditionally This describes the reason why a refund was not issued by the seller. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund
  .RefundFailureReason
  .RefundFailureCode 		RefundFailureCodeType Conditionally An enumerated value indicating the reason why a German or Austrian seller's attempt to distribute a refund to a buyer through the Order Adjustment API's issueRefund call failed. This field is only applicable to orders subject to the new eBay payment process on the German and Austrian sites.

Note: The new eBay payment process for German and Austrian sites has been put on hold indefinitely.

Applicable values:

•   PaypalBillingAgreementCanceled

(out) The refund attempt failed because the seller's billing agreement with PayPal has been cancelled.

Note: The new eBay payment process for German and Austrian sites has been put on hold indefinitely.

•   PaypalRiskDeclinesTransaction

(out) The refund attempt failed because because the PayPayl Risk team declined the transaction. The seller should log in to their PayPal account to proceed with the refund request.

Note: The new eBay payment process for German and Austrian sites has been put on hold indefinitely.


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


DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund
  .RefundFundingSourceArray 		RefundFundingSourceArrayType Conditionally This container lists the funding sources for the refund. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund
  .RefundFundingSourceArray
  .RefundFundingSource 		RefundFundingSourceType Conditionally,
repeatable: [0..*]		 The funding source for the refund issued by the seller through the Order Adjusment API's issueRefund call. It is possible that more than one funding source may be used for this refund.

Note: The new eBay payment process on the German and Austrian sites has been put on hold indefinitely.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund
  .RefundFundingSourceArray
  .RefundFundingSource
  .AccountNumber 		string Conditionally The account number of the funding source.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund
  .RefundFundingSourceArray
  .RefundFundingSource
  .BuyerExternalTransactionID 		string Conditionally The external transaction ID of the buyer's account.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund
  .RefundFundingSourceArray
  .RefundFundingSource
  .RefundAmount 		AmountType (double) Conditionally The amount of the refund.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund
  .RefundFundingSourceArray
  .RefundFundingSource
  .RefundingSourceType 		RefundingSourceTypeCodeType Conditionally The source from which the refund was made.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

Applicable values:

•   BankAccount

(out) The seller's bank account associated with the transaction.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

•   CustomCode

(out) Reserved for internal or future use.

•   Paypal

(out) The seller's PayPal account associated with the transaction.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

•   ScheduledPayout

(out) The seller's scheduled payout account with eBay. When a buyer pays for an item the purchase amount goes into this account. This value indicates that the refund has been issued from the seller's scheduled payout account.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund
  .RefundFundingSourceArray
  .RefundFundingSource
  .SellerExternalTransactionID 		string Conditionally The external transaction ID of the seller's account.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund.RefundID 		string Conditionally The refund ID for this refund. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.


Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund
  .RefundRequestedTime 		dateTime Conditionally The date and time when the refund was requested. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund
  .RefundStatus 		RefundStatusCodeType Conditionally A code indicating the status of the refund request. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Failed

(out) The refund request was rejected.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

•   Pending

(out) The refund request is being processed.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

•   Successful

(out) The refund request was successful.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund
  .RefundTransactionArray 		RefundTransactionArrayType Conditionally A container consisting of details about an order line item against which the seller issued a refund. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund
  .RefundTransactionArray
  .RefundTransaction 		RefundTransactionType Conditionally,
repeatable: [0..*]		 A container consisting of details about an order line item against which the seller issued a refund.

Note: The new eBay payment process on the German and Austrian sites has been put on hold indefinitely.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund
  .RefundTransactionArray
  .RefundTransaction.ItemID 		string Conditionally The item against which the refund was issued. This value must be accompanied by a TransactionID value.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund
  .RefundTransactionArray
  .RefundTransaction.OrderID 		string Conditionally The order against which the refund was issued. The presence of this value indicates that the refund was issued against the entire order.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund
  .RefundTransactionArray
  .RefundTransaction
  .RefundLineArray 		RefundLineArrayType Conditionally An array of refund lines identifying the order line items against which the refund was issued.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund
  .RefundTransactionArray
  .RefundTransaction
  .RefundLineArray.RefundLine 		RefundLineType (AmountType) Conditionally,
repeatable: [0..*]		 This field indicates the type and amount of the refund to the buyer involved in an DE/AT order order subject to the new eBay payment process. The type attribute indicates whether the refund is being applied against the purchase price or the shipping price. Using the issueRefund call of the Order Adjustment API, the seller can also issue an optional/additional refund that does not apply to the purchase price or shipping price. The type values are defined in the RefundLineTypeCodeType enumeration type.



RefundLine fields will only be returned if a refund has been issued from the seller to the buyer for a DE/AT order going through the new eBay payment process.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund
  .RefundTransactionArray
  .RefundTransaction
  .RefundLineArray.RefundLine
  [ attribute type ]		 RefundLineTypeCodeType Conditionally A code indicating the order line item to which the refund was applied.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

For a list of possible enumeration values, see RefundLineTypeCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund
  .RefundTransactionArray
  .RefundTransaction
  .TransactionID 		string Conditionally The transaction against which the refund was issued. This value must be accompanied by an ItemID value.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund
  .SellerNoteToBuyer 		string Conditionally Comments made by the the seller to the buyer. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: 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 selling partners on Shopping.com. This field is only returned for order line items purchased through the Shopping.com shopping cart.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .SellerDiscounts 		SellerDiscountsType Conditionally Seller Discounts

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .SellerDiscounts
  .OriginalItemPrice 		AmountType (double) Conditionally The original purchase price of the order line item (before any seller discounts are applied).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .SellerDiscounts
  .OriginalItemShippingCost 		AmountType (double) Conditionally The original shipping cost for the order line item. Note that shipping discounts have not yet been enabled for seller discount campaigns.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .SellerDiscounts
  .SellerDiscount 		SellerDiscountType Conditionally,
repeatable: [0..*]		 A container consisting of name and ID of the seller's discount campaign, as well as the discount amount that is being applied to the order line item. Note that shipping discounts have not yet been enabled for seller discount campaigns. Seller discount campaigns are created through the Order Size Discounts API.

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

See:
    Order Size Discounts API - createCampaigns call for for information on creating discount campaigns
    Related Items Management API - createBundles call for for information on creating product bundles

OrderArray.Order
  .TransactionArray.Transaction
  .SellerDiscounts
  .SellerDiscount
  .CampaignDisplayName 		string Conditionally The name of the seller discount campaign. A name can be associated with a seller discount campaign when the seller uses the createCampaigns or updateCampaigns calls of the Order Size Discounts API. The name for a discount campaign is optional, so this field will only be returned with the SellerDiscount container if defined for the seller discount campaign.

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

See campaign.name field in Order Size Discounts API.
OrderArray.Order
  .TransactionArray.Transaction
  .SellerDiscounts
  .SellerDiscount.CampaignID 		long Conditionally Unique identifier for a seller discount campaign. This ID is automatically created when the seller creates the discount campaign. This field is always returned with the SellerDiscount container.

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

See campaignId field in Order Size Discounts API.
OrderArray.Order
  .TransactionArray.Transaction
  .SellerDiscounts
  .SellerDiscount
  .ItemDiscountAmount 		AmountType (double) Conditionally The dollar amount of the order line item discount. The original purchase price (denoted in OriginalItemPrice) will be reduced by this value. The amount of the item discount will depend on the rules defined in the the seller discount campaign.

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

See campaign.offer container in Order Size Discounts API.
OrderArray.Order
  .TransactionArray.Transaction
  .SellerDiscounts
  .SellerDiscount
  .ShippingDiscountAmount 		AmountType (double) Conditionally The dollar amount of the shipping discount applied to the order line item. Note that shipping discounts have not yet been enabled for seller discount campaigns, so this field will not be returned until shipping discounts are enabled.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Status 		TransactionStatusType Conditionally Container consisting of status details of an order line item, including payment information. Several of these fields change values during the checkout flow. See TransactionStatusType for its child elements.

For GetOrders, only the IntegratedMerchantCreditCardEnabled and PaymentMethodUsed child elements are returned. The PaymentHoldStatus container will be returned for those sellers subject to the new eBay payment process. The fields indicating the status of the order are actually found in the OrderArray.Order.CheckoutStatus container.

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 flow for the order.

Applicable values:

•   BuyerRequestsTotal

(out) Buyer requests total from seller.

•   CheckoutComplete

(out) Checkout complete.

•   CheckoutIncomplete

(out) Checkout incomplete.

•   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 checkout is complete, incomplete, or pending for an order.

Applicable values:

•   Complete

(in/out) The order is complete. Generally speaking, an order is complete when payment from the buyer has been initiated and processed.

Note: If the PaymentMethodUsed is 'CashOnPickup', the CheckoutStatus.Status value in GetOrders will be 'Complete' right at Checkout, even though the seller may not have been officially paid yet. The CheckoutStatus.Status value in GetOrders will remain as 'Complete' even if the seller uses ReviseCheckoutStatus to change the checkout status to Pending. However, the eBayPaymentStatus value in GetOrders will change from 'NoPaymentFailure' to 'PaymentInProcess'.

•   CustomCode

(in/out) Reserved for internal or future use

•   Incomplete

(in/out) The order is incomplete. Generally speaking, an order is incomplete when payment from the buyer has yet to be initiated.

•   Pending

(in/out) The order is pending. Generally speaking, an order is pending when payment from the buyer has been initiated but has yet to be fully processed.

Note: If the PaymentMethod is CashOnPickup, the CheckoutStatus.Status value in GetOrders will read Complete right at Checkout, even though the seller may not have been officially paid yet. The CheckoutStatus.Status value in GetOrders will remain as Complete even if the seller uses ReviseCheckoutStatus to change the checkout status to Pending. However, the eBayPaymentStatus value in GetOrders will change from NoPaymentFailure to PaymentInProcess.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Status
  .eBayPaymentMismatchDetails 		eBayPaymentMismatchDetailsType Conditionally This container is returned when a buyer's payment does not match the total cost of an order going through the new eBay payment process. This container is only applicable for German and Austrian orders going through the new eBay payment process, and when the buyer has selected EFT as the payment method.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Status
  .eBayPaymentMismatchDetails
  .ActionRequiredBy 		dateTime Conditionally This dateTime value indicates the date by which the seller needs to accept or reject the overpayment/underpayment. If the seller doesn't take action by this date, eBay returns the payment to the buyer and essentially voids the sale. This field is always returned with the eBayPaymentMismatchDetails container.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.


DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Status
  .eBayPaymentMismatchDetails
  .MismatchAmount 		AmountType (double) Conditionally This value indicates the amount in which the buyer's payment was either over (MismatchType=OverPayment) or under (MismatchType=UnderPayment) the actual total cost of an order going through the new eBay payment process.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.


DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Status
  .eBayPaymentMismatchDetails
  .MismatchType 		MismatchTypeCodeType Conditionally This enumeration value indicates if the buyer has overpaid or underpaid for an order going through the new eBay payment process. This field is always returned with the eBayPaymentMismatchDetails container.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.


Applicable values:

•   CustomCode

(out) Reserved for internal or future use

•   OverPayment

(out) This value indicates that the buyer paid more than the required amount.

•   UnderPayment

(out) This value indicates that the buyer paid less than the required amount.




DetailLevel: 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 an order. Applicable for the payment method that the buyer chose for the order. If the payment failed, the value returned indicates the reason for the failure. Output only.

Applicable values:

•   BuyerCreditCardFailed

(out) This value indicates that the buyer's payment via a credit card failed. This value is only applicable if the seller accepts credit cards as a form of payment.

•   BuyerECheckBounced

(out) This value indicates that the buyer's eCheck bounced. This value is only applicable if the seller accepts eChecks as a form of payment.

•   BuyerFailedPaymentReportedBySeller

(out) This value indicates that the seller reported the buyer's payment as failed.

•   CustomCode

(out) Reserved for internal or future use.

•   NoPaymentFailure

(out) This value indicates that the buyer's payment for the order has cleared. A CheckoutStatus.eBayPaymentStatus value of 'NoPaymentFailure' and a CheckoutStatus.Status value of 'Complete' indicates that checkout is complete.

•   PaymentInProcess

(out) This value indicates that the buyer's non-PayPal payment is in process. This value is only applicable if the buyer has selected a payment method other than PayPal.

•   PayPalPaymentInProcess

(out) This value indicates that the buyer's PayPal payment is in process. This value is only applicable if the buyer has selected PayPal as the payment method.




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 an order's status 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 This field indicates the type and/or status of a payment hold on the item.

Applicable values:

•   CustomCode

(out) This value is reserved for internal or future use.

•   MerchantHold

(out) This value indicates a possible issue with a seller. If this value is returned, the TransactionArray.Transaction.SellerPaidStatus field is returned as PaidWithPayPal in GetMyeBaySelling, and the TransactionArray.Transaction.BuyerPaidStatus field is returned as PaidWithPayPal in GetMyeBayBuying.

•   NewSellerHold

(out) This value indicates that there is a "new seller hold" on the item. PayPal may hold payments to a new seller for up to 21 days. Sellers are considered "new" until they have met all three criteria below:

  • More than 90 days have passed since first successful sale
  • More than 25 domestic sales
  • More than $250.00 in total sales

•   None

(out) This value indicates that there is no payment hold on the item.

•   PaymentHold

(out) This value indicates that there is a payment hold on the item.

•   PaymentReview

(out) This value indicates a possible issue with a buyer. If this value is returned, the TransactionArray.Transaction.SellerPaidStatus field is returned as NotPaid in GetMyeBaySelling, and the TransactionArray.Transaction.BuyerPaidStatus field is returned as PaidWithPayPal in GetMyeBayBuying.

•   ReleaseConfirmed

(out) This value indicates that the funds are available in the seller's PayPal account.

•   Released

(out) This value indicates that a payment hold on the item has been released.

•   ReleasePending

(out) This value indicates that the process for the release of funds for the order has been initiated.




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 The payment method that the buyer selected to pay for the order. 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
  .Taxes 		TaxesType Conditionally

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

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

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   SalesTax

(out) A standard sales tax charge.

•   WasteRecyclingFee

(out) A charge for an electronic waste recycling fee.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Taxes.TaxDetails.TaxAmount 		AmountType (double) Conditionally This value is the total amount of sales tax for the order line item for the corresponding impositiion (tax type).

TaxAmount = TaxOnSubtotalAmount + TaxOnShippingAmount + TaxOnHandlingAmount

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

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   ElectronicWasteRecyclingFee

(out) A charge for an electronic waste recycling fee.

•   SalesTax

(out) A standard sales tax charge.

•   TireRecyclingFee

(out) A charge for a tire recycling fee.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Taxes.TaxDetails
  .TaxOnHandlingAmount 		AmountType (double) Conditionally This value is the amount of sales tax applied based on handling costs for the order line item for the corresponding impositiion (tax type).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Taxes.TaxDetails
  .TaxOnShippingAmount 		AmountType (double) Conditionally This value is the amount of sales tax applied based on shipping costs for the order line item for the corresponding impositiion (tax type).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Taxes.TaxDetails
  .TaxOnSubtotalAmount 		AmountType (double) Conditionally This value is the amount of sales tax applied based on the unit cost of the order line item for the corresponding impositiion (tax type).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .Taxes.TotalTaxAmount 		AmountType (double) Conditionally This value indicates the total tax amount for the order line item, including the sales tax on the item, the sales tax on shipping and handling, and any electronic waste recycling fee.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .TransactionID 		string Always Unique identifier for an eBay order line item. An order line item is created once there is a commitment from a buyer to purchase an item. Since an auction listing can only have one order line item during the duration of the listing, the TransactionID for auction listings is always 0. Along with its corresponding ItemID, a TransactionID is used and referenced during an order checkout flow and after checkout has been completed.

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

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .TransactionPrice 		AmountType (double) Always The price of one order line item.

This price is returned only for Best Offer items. This amount does not take into account shipping, sales tax, and other costs related to the order line item. If multiple units were purchased through Best Offer, this value is the per-unit price.

For eBay Motors Vehicle listings, 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 order line item (transaction) was created.

Applicable values: See TransactionSiteID.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .UnpaidItem 		UnpaidItemType Conditionally Container consisting of details related to the type and status of an Unpaid Item case. This container is only returned if there is an open or closed Unpaid Item case associated with the order line item.

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

Applicable values:

•   ClosedWithoutPayment

(out) This value indicates that the Unpaid Item case is closed with no payment received from the buyer.

•   ClosedWithPayment

(out) This value indicates that the Unpaid Item case is closed with payment received from the buyer.

•   CustomCode

(out) This value is reserved for future or internal use.

•   Open

(out) This value indicates that the Unpaid Item case is open.




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

Applicable values:

•   Auto

(out) This value indicates that the Unpaid Item case was opened automatically through eBay's Unpaid Item Assistant feature.

•   CustomCode

(out) This value is reserved for future or internal use.

•   Manual

(out) This value indicates that the seller opened an Unpaid Item case manually through the Resolution Center or by using the Trading API's AddDispute call.




DetailLevel: ReturnAll.

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

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

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

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

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

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

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

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

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

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

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

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

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 PlaceOffer: Required if the item being purchased includes Item Variations.
Max length: 40.

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 PlaceOffer: Required if the item being purchased includes Item Variations.
Max length: 50.

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 item variations(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.
Standard Output Fields  
Ack AckCodeType Always A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for 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 Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned.

Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors ErrorType Conditionally,
repeatable: [0..*]		 A list of application-level errors (if any) that occurred when eBay processed the request.

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

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   RequestError

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

•   SystemError

(out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
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 and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version string Always The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "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.



Back to top

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

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 documentation for clarification of conditions.
-The field is not returned.

Output Field none ItemReturnDescription ReturnAll
OrderArrayYYY
OrderArray.OrderYYY
OrderArray.Order.AdjustmentAmountYYY
OrderArray.Order.AmountPaid(Y)(Y)(Y)
OrderArray.Order.AmountSavedYYY
OrderArray.Order.BuyerCheckoutMessage(Y)(Y)(Y)
OrderArray.Order.BuyerUserIDYYY
OrderArray.Order.CheckoutStatusYYY
OrderArray.Order.CheckoutStatus.eBayPaymentMismatchDetails(Y)-(Y)
OrderArray.Order.CheckoutStatus.eBayPaymentMismatchDetails
  .ActionRequiredBy		(Y)-(Y)
OrderArray.Order.CheckoutStatus.eBayPaymentMismatchDetails
  .MismatchAmount		(Y)-(Y)
OrderArray.Order.CheckoutStatus.eBayPaymentMismatchDetails
  .MismatchType		(Y)-(Y)
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.CreatingUserRole(Y)(Y)(Y)
OrderArray.Order.ExternalTransaction--(Y)
OrderArray.Order.ExternalTransaction.ExternalTransactionStatus--(Y)
OrderArray.Order.ExternalTransaction.ExternalTransactionTime--(Y)
OrderArray.Order.ExternalTransaction.FeeOrCreditAmount--(Y)
OrderArray.Order.ExternalTransaction.PaymentOrRefundAmount--(Y)
OrderArray.Order.IntegratedMerchantCreditCardEnabledYYY
OrderArray.Order.IsMultiLegShipping(Y)(Y)(Y)
OrderArray.Order.MonetaryDetails-(Y)(Y)
OrderArray.Order.MonetaryDetails.Payments(Y)(Y)(Y)
OrderArray.Order.MonetaryDetails.Payments.Payment(Y)(Y)(Y)
OrderArray.Order.MonetaryDetails.Payments.Payment
  .FeeOrCreditAmount		(Y)(Y)(Y)
OrderArray.Order.MonetaryDetails.Payments.Payment.Payee(Y)(Y)(Y)
OrderArray.Order.MonetaryDetails.Payments.Payment.Payer(Y)(Y)(Y)
OrderArray.Order.MonetaryDetails.Payments.Payment.PaymentAmount(Y)(Y)(Y)
OrderArray.Order.MonetaryDetails.Payments.Payment.PaymentStatus(Y)(Y)(Y)
OrderArray.Order.MonetaryDetails.Payments.Payment.PaymentTime(Y)(Y)(Y)
OrderArray.Order.MonetaryDetails.Payments.Payment.ReferenceID(Y)(Y)(Y)
OrderArray.Order.MultiLegShippingDetails(Y)(Y)(Y)
OrderArray.Order.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider		(Y)(Y)(Y)
OrderArray.Order.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShippingServiceDetails		(Y)(Y)(Y)
OrderArray.Order.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShippingServiceDetails
  .ShippingService		(Y)(Y)(Y)
OrderArray.Order.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShippingServiceDetails
  .TotalShippingCost		(Y)(Y)(Y)
OrderArray.Order.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShippingTimeMax		(Y)(Y)(Y)
OrderArray.Order.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShippingTimeMin		(Y)(Y)(Y)
OrderArray.Order.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress		(Y)(Y)(Y)
OrderArray.Order.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress.AddressID		(Y)(Y)(Y)
OrderArray.Order.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress.AddressOwner		(Y)(Y)(Y)
OrderArray.Order.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress.AddressUsage		(Y)-(Y)
OrderArray.Order.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress.CityName		(Y)(Y)(Y)
OrderArray.Order.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress.Country		(Y)(Y)(Y)
OrderArray.Order.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress.CountryName		(Y)(Y)(Y)
OrderArray.Order.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress
  .ExternalAddressID		(Y)(Y)(Y)
OrderArray.Order.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress.Name		(Y)(Y)(Y)
OrderArray.Order.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress.Phone		(Y)(Y)(Y)
OrderArray.Order.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress.PostalCode		(Y)(Y)(Y)
OrderArray.Order.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress.ReferenceID		(Y)-(Y)
OrderArray.Order.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress.StateOrProvince		(Y)(Y)(Y)
OrderArray.Order.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress.Street1		(Y)(Y)(Y)
OrderArray.Order.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress.Street2		(Y)(Y)(Y)
OrderArray.Order.OrderIDYYY
OrderArray.Order.OrderStatusYYY
OrderArray.Order.PaidTime(Y)(Y)(Y)
OrderArray.Order.PaymentHoldDetails(Y)(Y)(Y)
OrderArray.Order.PaymentHoldDetails.ExpectedReleaseDateYYY
OrderArray.Order.PaymentHoldDetails.NumOfReqSellerActionsYYY
OrderArray.Order.PaymentHoldDetails.PaymentHoldReason(Y)(Y)(Y)
OrderArray.Order.PaymentHoldDetails.RequiredSellerActionArrayYYY
OrderArray.Order.PaymentHoldDetails.RequiredSellerActionArray
  .RequiredSellerAction		(Y)(Y)(Y)
OrderArray.Order.PaymentHoldStatusYYY
OrderArray.Order.PaymentMethodsYYY
OrderArray.Order.RefundArray(Y)-(Y)
OrderArray.Order.RefundArray.Refund(Y)-(Y)
OrderArray.Order.RefundArray.Refund.EstimatedRefundCompletionTime(Y)-(Y)
OrderArray.Order.RefundArray.Refund.ExternalReferenceID(Y)-(Y)
OrderArray.Order.RefundArray.Refund.RefundAmount(Y)-(Y)
OrderArray.Order.RefundArray.Refund.RefundCompletionTime(Y)-(Y)
OrderArray.Order.RefundArray.Refund.RefundFailureReason(Y)-(Y)
OrderArray.Order.RefundArray.Refund.RefundFailureReason
  .RefundFailureCode		(Y)-(Y)
OrderArray.Order.RefundArray.Refund.RefundFundingSourceArray(Y)-(Y)
OrderArray.Order.RefundArray.Refund.RefundFundingSourceArray
  .RefundFundingSource		(Y)-(Y)
OrderArray.Order.RefundArray.Refund.RefundFundingSourceArray
  .RefundFundingSource.AccountNumber		(Y)-(Y)
OrderArray.Order.RefundArray.Refund.RefundFundingSourceArray
  .RefundFundingSource.BuyerExternalTransactionID		(Y)-(Y)
OrderArray.Order.RefundArray.Refund.RefundFundingSourceArray
  .RefundFundingSource.RefundAmount		(Y)-(Y)
OrderArray.Order.RefundArray.Refund.RefundFundingSourceArray
  .RefundFundingSource.RefundingSourceType		(Y)-(Y)
OrderArray.Order.RefundArray.Refund.RefundFundingSourceArray
  .RefundFundingSource.SellerExternalTransactionID		(Y)-(Y)
OrderArray.Order.RefundArray.Refund.RefundID(Y)-(Y)
OrderArray.Order.RefundArray.Refund.RefundRequestedTime(Y)-(Y)
OrderArray.Order.RefundArray.Refund.RefundStatus(Y)-(Y)
OrderArray.Order.RefundArray.Refund.RefundTransactionArray(Y)-(Y)
OrderArray.Order.RefundArray.Refund.RefundTransactionArray
  .RefundTransaction		(Y)-(Y)
OrderArray.Order.RefundArray.Refund.RefundTransactionArray
  .RefundTransaction.ItemID		(Y)-(Y)
OrderArray.Order.RefundArray.Refund.RefundTransactionArray
  .RefundTransaction.OrderID		(Y)-(Y)
OrderArray.Order.RefundArray.Refund.RefundTransactionArray
  .RefundTransaction.RefundLineArray		(Y)-(Y)
OrderArray.Order.RefundArray.Refund.RefundTransactionArray
  .RefundTransaction.RefundLineArray.RefundLine		(Y)-(Y)
OrderArray.Order.RefundArray.Refund.RefundTransactionArray
  .RefundTransaction.TransactionID		(Y)-(Y)
OrderArray.Order.RefundArray.Refund.SellerNoteToBuyer(Y)-(Y)
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.AddressUsage(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.ImportCharge		(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.ShipmentTrackingDetails(Y)(Y)(Y)
OrderArray.Order.ShippingDetails.ShipmentTrackingDetails
  .ShipmentTrackingNumber		(Y)(Y)(Y)
OrderArray.Order.ShippingDetails.ShipmentTrackingDetails
  .ShippingCarrierUsed		(Y)(Y)(Y)
OrderArray.Order.ShippingDetails.ShippingServiceOptions(Y)(Y)(Y)
OrderArray.Order.ShippingDetails.ShippingServiceOptions
  .ExpeditedService		(Y)(Y)(Y)
OrderArray.Order.ShippingDetails.ShippingServiceOptions
  .ImportCharge		(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.ImportCharge(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.ActualHandlingCostYYY
OrderArray.Order.TransactionArray.Transaction.ActualShippingCostYYY
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
  .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.StaticAlias--(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
  .ExternalTransactionStatus		--(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.IntangibleItem(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.InvoiceSentTime--(Y)
OrderArray.Order.TransactionArray.Transaction.IsMultiLegShipping(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		(Y)(Y)(Y)
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.MonetaryDetails(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.MonetaryDetails
  .Payments		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.MonetaryDetails
  .Payments.Payment		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.MonetaryDetails
  .Payments.Payment.FeeOrCreditAmount		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.MonetaryDetails
  .Payments.Payment.Payee		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.MonetaryDetails
  .Payments.Payment.Payer		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.MonetaryDetails
  .Payments.Payment.PaymentAmount		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.MonetaryDetails
  .Payments.Payment.PaymentStatus		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.MonetaryDetails
  .Payments.Payment.PaymentTime		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.MonetaryDetails
  .Payments.Payment.ReferenceID		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.PaymentHoldDetails--(Y)
OrderArray.Order.TransactionArray.Transaction.PaymentHoldDetails
  .ExpectedReleaseDate		YYY
OrderArray.Order.TransactionArray.Transaction.PaymentHoldDetails
  .NumOfReqSellerActions		YYY
OrderArray.Order.TransactionArray.Transaction.PaymentHoldDetails
  .PaymentHoldReason		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.PaymentHoldDetails
  .RequiredSellerActionArray		YYY
OrderArray.Order.TransactionArray.Transaction.PaymentHoldDetails
  .RequiredSellerActionArray.RequiredSellerAction		(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.RefundArray(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund
  .EstimatedRefundCompletionTime		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund
  .ExternalReferenceID		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund
  .RefundAmount		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund
  .RefundCompletionTime		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund
  .RefundFailureReason		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund
  .RefundFailureReason.RefundFailureCode		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund
  .RefundFundingSourceArray		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund
  .RefundFundingSourceArray.RefundFundingSource		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund
  .RefundFundingSourceArray.RefundFundingSource.AccountNumber		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund
  .RefundFundingSourceArray.RefundFundingSource
  .BuyerExternalTransactionID		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund
  .RefundFundingSourceArray.RefundFundingSource.RefundAmount		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund
  .RefundFundingSourceArray.RefundFundingSource.RefundingSourceType		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund
  .RefundFundingSourceArray.RefundFundingSource
  .SellerExternalTransactionID		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund
  .RefundID		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund
  .RefundRequestedTime		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund
  .RefundStatus		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund
  .RefundTransactionArray		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund
  .RefundTransactionArray.RefundTransaction		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund
  .RefundTransactionArray.RefundTransaction.ItemID		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund
  .RefundTransactionArray.RefundTransaction.OrderID		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund
  .RefundTransactionArray.RefundTransaction.RefundLineArray		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund
  .RefundTransactionArray.RefundTransaction.RefundLineArray
  .RefundLine		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund
  .RefundTransactionArray.RefundTransaction.TransactionID		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund
  .SellerNoteToBuyer		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction
  .SellerContactBuyerByEmail		(Y)(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.SellerDiscounts(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.SellerDiscounts
  .OriginalItemPrice		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.SellerDiscounts
  .OriginalItemShippingCost		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.SellerDiscounts
  .SellerDiscount		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.SellerDiscounts
  .SellerDiscount.CampaignDisplayName		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.SellerDiscounts
  .SellerDiscount.CampaignID		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.SellerDiscounts
  .SellerDiscount.ItemDiscountAmount		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.SellerDiscounts
  .SellerDiscount.ShippingDiscountAmount		(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
  .eBayPaymentMismatchDetails		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.Status
  .eBayPaymentMismatchDetails.ActionRequiredBy		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.Status
  .eBayPaymentMismatchDetails.MismatchAmount		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.Status
  .eBayPaymentMismatchDetails.MismatchType		(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.Taxes(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.Taxes.TaxDetails(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.Taxes.TaxDetails
  .Imposition		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.Taxes.TaxDetails
  .TaxAmount		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.Taxes.TaxDetails
  .TaxDescription		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.Taxes.TaxDetails
  .TaxOnHandlingAmount		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.Taxes.TaxDetails
  .TaxOnShippingAmount		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.Taxes.TaxDetails
  .TaxOnSubtotalAmount		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.Taxes
  .TotalTaxAmount		(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.TransactionIDYYY
OrderArray.Order.TransactionArray.Transaction.TransactionPriceYYY
OrderArray.Order.TransactionArray.Transaction.TransactionSiteID(Y)-(Y)
OrderArray.Order.TransactionArray.Transaction.UnpaidItem--(Y)
OrderArray.Order.TransactionArray.Transaction.UnpaidItem.Status--(Y)
OrderArray.Order.TransactionArray.Transaction.UnpaidItem.Type--(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 User Notes

GetOrderTransactions Samples

New to making API calls? Please see Routing the Request.

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

Sample: Basic Call

Retrieves order information for a specified order ID.

Description

Bountiful Buyer wants to review the status of her orders, in particular, OrderID number 865826.

Input

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<GetOrderTransactionsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <OrderIDArray>
    <OrderID>865826</OrderID>
  </OrderIDArray>
</GetOrderTransactionsRequest>

Output

XML format. Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<GetOrderTransactionsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2007-12-10T16:15:02.112Z</Timestamp>
  <Ack>Success</Ack>
  <Version>539</Version>
  <Build>e539_core_Bundled_5642307_R1</Build>
  <OrderArray>
    <Order>
      <OrderID>865826</OrderID>
      <OrderStatus>Active</OrderStatus>
      <AdjustmentAmount currencyID="USD">0.0</AdjustmentAmount>
      <AmountSaved currencyID="USD">0.0</AmountSaved>
      <CheckoutStatus>
        <eBayPaymentStatus>NoPaymentFailure</eBayPaymentStatus>
        <LastModifiedTime>2007-12-10T16:09:47.000Z</LastModifiedTime>
        <PaymentMethod>None</PaymentMethod>
        <Status>Incomplete</Status>
      </CheckoutStatus>
      <ShippingDetails>
        <SalesTax>
          <SalesTaxPercent>0.0</SalesTaxPercent>
          <SalesTaxState/>
          <ShippingIncludedInTax>false</ShippingIncludedInTax>
          <SalesTaxAmount currencyID="USD">0.0</SalesTaxAmount>
        </SalesTax>
        <ShippingServiceOptions>
          <ShippingService>ShippingMethodStandard</ShippingService>
          <ShippingServicePriority>1</ShippingServicePriority>
          <ExpeditedService>false</ExpeditedService>
        </ShippingServiceOptions>
        <SellingManagerSalesRecordNumber>111</SellingManagerSalesRecordNumber>
        <GetItFast>false</GetItFast>
      </ShippingDetails>
      <CreatingUserRole>Seller</CreatingUserRole>
      <CreatedTime>2007-12-10T16:09:47.000Z</CreatedTime>
      <PaymentMethods>PayPal</PaymentMethods>
      <ShippingAddress>
        <Name>Test User</Name>
        <Street1>address</Street1>
        <Street2/>
        <CityName>city</CityName>
        <StateOrProvince>WA</StateOrProvince>
        <Country>CustomCode</Country>
        <CountryName/>
        <Phone>1-800-111-1111</Phone>
        <PostalCode>98102</PostalCode>
        <AddressID>3839387</AddressID>
        <AddressOwner>eBay</AddressOwner>
        <ExternalAddressID/>
      </ShippingAddress>
      <ShippingServiceSelected>
        <ShippingService>NotSelected</ShippingService>
        <ShippingServiceCost currencyID="USD">0.0</ShippingServiceCost>
      </ShippingServiceSelected>
      <Subtotal currencyID="USD">36.0</Subtotal>
      <Total currencyID="USD">36.0</Total>
      <DigitalDelivery>false</DigitalDelivery>
      <TransactionArray>
        <Transaction>
          <AmountPaid currencyID="USD">18.0</AmountPaid>
          <AdjustmentAmount currencyID="USD">0.0</AdjustmentAmount>
          <ConvertedAdjustmentAmount currencyID="USD">0.0</ConvertedAdjustmentAmount>
          <ConvertedAmountPaid currencyID="USD">18.0</ConvertedAmountPaid>
          <ConvertedTransactionPrice currencyID="USD">18.0</ConvertedTransactionPrice>
          <CreatedDate>2007-12-05T22:26:46.000Z</CreatedDate>
          <DepositType>None</DepositType>
          <Item>
            <AutoPay>false</AutoPay>
            <BuyerProtection>ItemIneligible</BuyerProtection>
            <ItemID>110025788368</ItemID>
            <ListingType>Chinese</ListingType>
            <PrivateListing>false</PrivateListing>
            <SellingStatus>
              <CurrentPrice currencyID="USD">18.0</CurrentPrice>
              <ListingStatus>Completed</ListingStatus>
            </SellingStatus>
            <GetItFast>false</GetItFast>
          </Item>
          <QuantityPurchased>1</QuantityPurchased>
          <Status>
            <eBayPaymentStatus>NoPaymentFailure</eBayPaymentStatus>
            <CheckoutStatus>CheckoutIncomplete</CheckoutStatus>
            <LastTimeModified>2007-12-05T22:26:46.000Z</LastTimeModified>
            <PaymentMethodUsed>None</PaymentMethodUsed>
            <CompleteStatus>Incomplete</CompleteStatus>
          </Status>
          <TransactionID>0</TransactionID>
          <TransactionPrice currencyID="USD">18.0</TransactionPrice>
          <TransactionSiteID>US</TransactionSiteID>
          <Platform>CustomCode</Platform>
        </Transaction>
        <Transaction>
          <AmountPaid currencyID="USD">18.0</AmountPaid>
          <AdjustmentAmount currencyID="USD">0.0</AdjustmentAmount>
          <ConvertedAdjustmentAmount currencyID="USD">0.0</ConvertedAdjustmentAmount>
          <ConvertedAmountPaid currencyID="USD">18.0</ConvertedAmountPaid>
          <ConvertedTransactionPrice currencyID="USD">18.0</ConvertedTransactionPrice>
          <CreatedDate>2007-12-05T22:26:32.000Z</CreatedDate>
          <DepositType>None</DepositType>
          <Item>
            <AutoPay>false</AutoPay>
            <BuyerProtection>ItemIneligible</BuyerProtection>
            <ItemID>110025788765</ItemID>
            <ListingType>Chinese</ListingType>
            <PrivateListing>false</PrivateListing>
            <SellingStatus>
              <CurrentPrice currencyID="USD">18.0</CurrentPrice>
              <ListingStatus>Completed</ListingStatus>
            </SellingStatus>
            <GetItFast>false</GetItFast>
          </Item>
          <QuantityPurchased>1</QuantityPurchased>
          <Status>
            <eBayPaymentStatus>NoPaymentFailure</eBayPaymentStatus>
            <CheckoutStatus>CheckoutIncomplete</CheckoutStatus>
            <LastTimeModified>2007-12-05T22:26:32.000Z</LastTimeModified>
            <PaymentMethodUsed>None</PaymentMethodUsed>
            <CompleteStatus>Incomplete</CompleteStatus>
          </Status>
          <TransactionID>0</TransactionID>
          <TransactionPrice currencyID="USD">18.0</TransactionPrice>
          <TransactionSiteID>US</TransactionSiteID>
          <Platform>CustomCode</Platform>
        </Transaction>
      </TransactionArray>
      <BuyerUserID>bountifulbuyer</BuyerUserID>
    </Order>
  </OrderArray>
</GetOrderTransactionsResponse>



Back to top

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

GetOrderTransactions Change History

Version Description
827
2013-06-05
  • MonetaryDetails (added): This container and its child fields (Payments, Payment, FeeOrCreditAmount, Payee, Payer, PaymentAmount, PaymentStatus, PaymentTime and ReferenceID) provide information about how funds exchanged for an order are allocated to payees. For example, for an order made under eBay's Global Shipping Program, users can see the portion of the buyer's payment that is allocated as shipping and import charges remitted to the international shipping provider. Currently, only payment information is returned.
  • ExternalTransactionStatus (added): Enumerated value that indicates the current processing status of a PayPal payment for an eBay order.
821
2013-04-24
  • OrderArray.Order.PaymentHoldDetails.RequiredSellerActionArray.RequiredSellerAction (modified): 'ResolveReturn' added as a value for RequiredSellerActionCodeType. 'ResolveReturn' will be returned if the the buyer is returning the item through eBay's managed return process. The seller will have to resolve the return case and issue a refund to the buyer before the Final Value Fee for the original sale is credited back to the seller's account.
  • OrderArray.Order.TransactionArray.Transaction.PaymentHoldDetails.RequiredSellerActionArray.RequiredSellerAction (modified): 'ResolveReturn' added as a value for RequiredSellerActionCodeType. 'ResolveReturn' will be returned if the the buyer is returning the item through eBay's managed return process. The seller will have to resolve the return case and issue a refund to the buyer before the Final Value Fee for the original sale is credited back to the seller's account.
811
2013-02-13
  • PaymentHoldDetails.PaymentHoldReason (added): Enumerated value that indicates why the buyer's payment for the order is being held by PayPal instead of being distributed to the seller's account.
  • PaymentHoldDetails.RequiredSellerAction.ResolveBuyerMessageInr (added): A RequiredSellerAction value that indicates that the buyer has not received the item, and the buyer has contacted the seller through the eBay system in an effort to resolve the issue with the seller. The seller must make it right with the buyer in order to expedite the release of funds into their account.
  • PaymentHoldDetails.RequiredSellerAction.ResolveBuyerMessageSnad (added): A RequiredSellerAction value that indicates that the buyer has received the item, but the item is not as described in the listing; hence, the buyer has contacted the seller through the eBay system in an effort to resolve the issue with the seller. The seller must make it right with the buyer in order to expedite the release of funds into their account.
  • PaymentHoldDetails.RequiredSellerAction.UploadTrackingInfo (added): A RequiredSellerAction value that indicates that the seller must provide the buyer the tracking information for the order line item to expedite the release of funds into their account.
807
2013-01-23
  • TransactionPrice (doc change): The description of this field was incorrect. TransactionPrice is the price of one order line item. This price is returned only for Best Offer items. This amount does not take into account shipping, sales tax, and other costs related to the order line item. If multiple units were purchased through Best Offer, this value is the per-unit price.
  • Transaction.ActualShippingCost (doc change): Clarified that Transaction.ActualShippingCost is the shipping cost charged to the buyer for an order line item. This is different from the field of the same name returned by GetSellingManagerSaleRecord and ReviseSellingManagerSaleRecord, which contains the actual shipping cost paid by the seller.
799
2012-11-07
  • ShippingDetailsType.InternationalShippingServiceOption (doc change): The description clarifies that a seller can offer up to four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program, only four other international shipping services may be offered (regardless of whether or not Global Shipping is offered for the listing).
795
2012-10-10
  • Order.ShippingServiceSelected (doc change): Added a note to explain that for GetOrders and GetOrderTransactions, if you provide OrderLineItemID values in the OrderID field, this container does not return accurate shipping service and cost information for multiple line item orders. You must provide the order's combined OrderID value to ensure that the ShippingService and ShippingServiceCost fields return the correct values for the order.
793
2012-09-26
  • MultiLegShippingDetails (modified): This container was previously returned at both the transaction and order levels; it is now returned at only the order level (OrderArray.Order.MultiLegShippingDetails).
791
2012-09-12
  • InternationalShippingServiceOption.ShippingService (modified): New International shipping services added for UK and DE sites as part of the EU delivery estimate project. For UK, these new enumeration values are UK_ParcelForceIntlExpress, UK_ParcelForceIntlValue, and UK_ParcelForceIntlEconomy. For DE, these new enumeration values are DE_DeutschePostBriefIntlEcon and DE_DeutschePostBriefIntlPriority.
789
2012-08-29
  • Transaction.IntangibleItem (added): This flag indicates whether or not the order line item is an intangible good such as an MP3 track or a mobile phone ringtone. This value is primarily used by PayPal to see if the item qualifies for PayPal's Seller Protection program.
  • Transaction.InvoiceSentTime (added): This field indicates the date/time that an order invoice was sent from the seller to the buyer.
  • Transaction.UnpaidItem (added): This container consists of details related to the type and status of an Unpaid Item case.
783
2012-07-18
  • OrderArray.Order.ShippingServiceSelected.ImportCharge (added): Thyis field provides the same information as OrderArray.Order.ShippingDetails.InternationalShippingServiceOption.ImportCharge: the total cost of customs and taxes that will be applied to a item shipped internationally using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
  • LogisticsProviderShipmentToBuyer (doc change): LogisticsProviderShipmentToBuyer and its child fields (including ShippingServiceDetails) were incorrectly documented. They are not part of this call.
  • ShipmentLineItem (doc change): ShipmentLineItem and its child fields (including LineItem and CountryOfOrigin) were incorrectly documented. They are not part of this call.
781
2012-07-04
  • ReferenceID (modified): This field appears only in SellerShipmentToLogisticsProvider.ShipToAddress.
  • ShippingServiceCodeType (modified): AU_StandardDeliveryFromOutsideAU added as a shipping service option. This option can be specified by sellers on the AU site if the item is being shipped from a location outside of Australia using standard delivery.
777
2012-06-06
  • IsMultiLegShipping (added): IsMultiLegShipping is returned in OrderArray.Order and OrderArray.Order.TransactionArray.Transaction, and indicates whether the order or transaction uses the Global Exchange program, in which the shipment has a domestic leg and an international leg.
  • MultiLegShippingDetails (added): MultiLegShippingDetails is returned in OrderArray.Order and OrderArray.Order.TransactionArray.Transaction, and contains information about the domestic and international legs of a Global Exchange program shipment.
    The two legs are represented by child containers: LogisticsProviderShipmentToBuyer and SellerShipmentToLogisticsProvider.
  • MultiLegShippingDetails.LogisticsProviderShipmentToBuyer (added): This container provides information about the shipping service, cost, address, and delivery estimates for the international leg of a Global Exchange shipment. The ShippingServiceDetails child container provides the name of the shipping service and the total shipping cost.
  • MultiLegShippingDetails.SellerShipmentToLogisticsProvider (added): This container provides information about the shipping service, cost, address, and delivery estimates for the domestic leg of a Global Exchange shipment. The ShippingServiceDetails child container provides the name of the shipping service and the total shipping cost.
  • ReferenceID (added): ReferenceID is returned in LogisticsProviderShipmentToBuyer.ShipToAddress, SellerShipmentToLogisticsProvider.ShipToAddress and OrderArray.Order.ShippingAddress. Its value is generated by eBay when the order is completed, and it uniquely identifies an order shipped using the Global Exchange program. It must appear on the shipping label.
  • ImportCharge (added): The total cost of customs and taxes that will be applied to a item shipped internationally using the Global Exchange program. ImportCharge is returned in OrderArray.Order.ShippingDetails.InternationalShippingServiceOption. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
  • ShipmentLineItem (added): Contains information about one or more order line items in a Global Exchange package. ShipmentLineItem is returned in OrderArray.Order.ShippingDetails.ShipmentTrackingDetails.
  • ShipmentLineItem.LineItem (added): Contains information about one order line item in a Global Exchange package, including the Country of Manufacture and the number of units of the order line item in the package, both of which are required for customs. The package can contain multiple order line items.
771
2012-04-25
  • eBayPaymentMismatchDetails.MismatchAmount (added): This value indicates the amount that the buyer's payment was either over or under the actual order cost.
  • RequiredSellerActionCodeType.ContacteBayCS (added): This value indicates that the DE/AT seller should contact eBay Customer Support to discover the next required action.
  • RequiredSellerActionCodeType.ResolvePPPICase (added): This value indicates that the DE/AT seller must resolve PayPal Buyer Protection case.
  • RequiredSellerActionCodeType.SetupPayoutMethod (added): This value indicates that the DE/AT seller must set up a valid payout account in order to receive seller payouts.
  • RequiredSellerActionCodeType.UpdatePayoutMethod (added): This value indicates that the DE/AT seller must update to a valid payout account in order to receive seller payouts.
765
2012-03-14
  • Refund (modified): 11 new fields added to support refunds in eBay's new payment process.
    The new fields are: EstimatedRefundCompletionTime, ExternalReferenceId, RefundAmount, RefundCompletionTime, RefundFailureReason, RefundFundingSourceArray, RefundID, RefundRequestedTime, RefundStatus, RefundTransactionArray and SellerNoteToBuyer.
  • RefundFailureReason (added): A container for the RefundFailureCode.
  • RefundFailureCode (added): A code indicating the reason why a refund was not issued by the seller.
    The enumeration values are: PaypalBillingAgreementCanceled and PaypalRiskDeclinesTransaction.
  • RefundFundingSourceArray (added): Container consisting of zero or more RefundFundingSource containers.
  • RefundFundingSource (added): Contains information about the funding source for the refund.
    The fields are: AccountNumber, BuyerExternalTransactionID, RefundAmount, RefundingSourceType and SellerExternalTransactionID.
  • RefundingSourceType (added): A code indicating the source from which the refund was made.
    The enumeration values are: BankAccount, Paypal and ScheduledPayout.
  • RefundStatus (added): A code indicating the status of the refund request.
    The enumeration values are: Failed, Pending and Successful.
  • RefundTransactionArray (added): A container consisting of zero or more RefundTransaction containers.
  • RefundTransaction (added): A container consisting of details about the transaction against which the seller issued a refund.
    The fields are: ItemID, OrderID, RefundLineArray and TransactionID.
  • RefundLineArray (added): A container consisting of zero or more refund lines.
  • RefundLine (added): The order line item to which the refund was applied.
    The RefundLine attribute, Type, has these enumeration values: Additional, PurchasePrice and ShippingPrice.
  • Order.CheckoutStatus.eBayPaymentMismatchDetails, Transaction.Status.eBayPaymentMismatchDetails (added): This response container is returned to DE/AT sellers (ramped up in the new eBay payment process) if the buyer underpaid or overpaid for an order going through the new eBay payment process flow. This container consists of the payment mismatch type and a date by which the seller must either accept or reject the over/under payment.
741
2011-09-28
  • eBayPaymentStatus.Paid (added): New enum value that indicates that the buyer has paid for an order.
739
2011-09-14
  • OrderArray.Order.TransactionArray.Transaction.SellerDiscounts (added): A container consisting of one or more SellerDiscount nodes, as well as the original item and shipping cost.
735
2011-08-17
  • OrderArray.Order.TransactionArray.Transaction.Status.PaymentMethodUsed (deprecated): StandardPaymentMethod is no longer returned.
731
2011-07-20
  • PaymentHoldStatusCodeType (modified): ReleaseConfirmed, ReleaseFailed, and ReleasePending added as enumeration values to capture the status of the release of funds to a seller's account.
719
2011-04-27
  • ShippingServiceCodeType (modified): 15 new shipping services added for the Australia and Canada sites. The nine new Australia carrier-specific shipping services include AU_AusPostRegisteredPostInternationalPaddedBag1kg, AU_AusPostRegisteredPostInternationalPaddedBag500g, AU_AusPostRegisteredPostInternationalParcel, AU_AustralianAirExpressFlatRate1kg, AU_AustralianAirExpressFlatRate3kg, AU_AustralianAirExpressFlatRate5kg, AU_AustralianAirExpressMetro15kg, AU_eBayAusPost3kgFlatRateSatchel, and AU_eBayAusPost500gFlatRateSatchel. The nine new Australia generic service level shipping services include AU_EconomyDeliveryFromOutsideAU, AU_ExpeditedDeliveryFromOutsideAU, AU_ExpressDelivery, AU_Freight, and AU_StandardDelivery. The new Canada shipping service is CA_Freight.
  • Item.ShippingDetails.ShippingServiceOptions (modified): '4' has been added as a valid integer value to account for the additional international shipping service that may be specified by the seller.
  • Item.ShippingDetails.InternationalShippingServiceOption (modified): '4' and '5' have been added as valid integer values to account for the additional international shipping services that may be specified by the seller.
  • TransactionType.FinalValueFee (modified): For non-store, auction listings on North America sites, the FinalValueFee value may change upon checkout based on all costs associated with Shipping, including handling and shipping insurance charges.
  • RequiredSellerActionArrayType (added): A container consisting of zero or more actions (returned in RequiredSellerAction fields) that a seller may take to possibly expedite the release of a payment hold on an order line item.
  • RequiredSellerActionCodeType (added): MarkAsShipped and ResolveeBPCase added as actions that a seller may take to possibly expedite the release of a payment hold on an order line item.
  • OrderType.PaymentHoldDetails (added): Starting in June 2011, this container will be returned if a seller's funds are placed in hold status. This container consists of the expected release date of the payment hold, as well as possible actions that a seller can take to expedite the release of the payment hold.
  • TransactionType.PaymentHoldDetails (added): Starting in June 2011, this container will be returned if a seller's funds are placed in hold status. This container consists of the expected release date of the payment hold, as well as possible actions that a seller can take to expedite the release of the payment hold.
  • PaymentHoldStatusCodeType (added): New code type that indicates the type and/or status of a payment hold.
705
2011-01-19
  • OrderLineItemID (modified): The OrderLineItemID value can now be used in Production to identify a single line item order. OrderLineItemID can substitute for an ItemID/TransactionID pair in an ItemTransactionID node, or the OrderLineItemID value can be passed into an OrderID field (for single line item orders only) under the OrderIDArray container. The OrderLineItemID is also returned under each Transaction node in the response.
691
2010-10-14
  • OrderLineItemID (added): A unique identifier for an eBay transaction, which is based upon the concatenation of ItemID and TransactionID with a hyphen in between these two IDs. If you set your request version to 705, OrderLineItemID can be used instead of ItemID and TransactionID in the request.
675
2010-06-23
  • Transaction.Taxes (added): Reserved for future use.
673
2010-06-09
  • StaticAlias (added): The StaticAlias field contains the static email address of an eBay member. As of summer 2010, the StaticAlias field is returned by this call as an addition to the existing Email field.
663
2010-03-31
  • PaymentHoldStatus (modified): If a new seller hold applies to the buyer's payment, a PaymentHoldStatus of NewSellerHold is returned.
653
2010-01-13
  • ShipmentType.ShipmentTrackingDetails: ShipmentTrackingNumber and ShippingServiceUsed (modified): Now returned for Trading and Half.com.
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.



Back to top

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

User-Contributed Notes

   
 
 
 

Copyright © 2005–2013 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.