GetOrders

Retrieves all of the orders for which the user is a participant (as either buyer or seller) that meet the criteria specified in the request.

An order is a combination of two or more transactions.

There are two mutually exclusive sets of filtering input arguments that you can use to query for orders. The first set is based on specific order IDs (one or more order IDs are passed in the call). The second set is a combination of date range, order role, and order status. If you use one set of filtering arguments, the arguments for the other filtering mechanism should not be specified in the same call. If a given call to GetOrders includes both criteria sets, the query based on order IDs is used, and the criteria for date range/order status/order role is ignored.

Applicable to Half.com (used to retrieve unshipped Half.com orders, such as orders that the seller has received but has not yet processed).

See Working with Combined Payment.

See also the reference documentation for these calls:



Back to top

Input Output Detail Controls Samples Change History Top Errors for GetOrders
GetOrders 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"?>
<GetOrdersRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Input Fields -->
  <DetailLevel> DetailLevelCodeType </DetailLevel>
  <!-- ... more DetailLevel nodes here ... -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <OutputSelector> string </OutputSelector>
  <!-- ... more OutputSelector nodes here ... -->
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
  <!-- Call-specific Input Fields -->
  <CreateTimeFrom> dateTime </CreateTimeFrom>
  <CreateTimeTo> dateTime </CreateTimeTo>
  <ListingType> ListingTypeCodeType </ListingType>
  <OrderIDArray> OrderIDArrayType 
    <OrderID> OrderIDType (string) </OrderID>
    <!-- ... more OrderID nodes here ... -->
  </OrderIDArray>
  <OrderRole> TradingRoleCodeType </OrderRole>
  <OrderStatus> OrderStatusCodeType </OrderStatus>
  <Pagination> PaginationType 
    <EntriesPerPage> int </EntriesPerPage>
    <PageNumber> int </PageNumber>
  </Pagination>
</GetOrdersRequest>
Argument Type Occurrence Meaning
Standard Input Fields   [Jump to call-specific fields]
DetailLevel DetailLevelCodeType Optional,
repeatable: [0..*]		 Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. For example, a particular detail level might cause the response to include buyer-related data in every result (e.g., for every Item), but no seller-related data. Specifying a detail level is like using a predefined attribute list in the SELECT clause of an SQL query. Use the DetailLevel element to specify the required detail level that the client application needs pertaining to the data components that are applicable to the request.

The DetailLevelCodeType defines the global list of available detail levels for all request types. Most request types support certain detail levels or none at all. If you pass a detail level that exists in the schema but that isn't valid for a particular request, eBay ignores it processes the request without it. For each request type, see the detail level tables in the Input/Output Reference to determine which detail levels are applicable and which elements are returned for each applicable detail level. (Some detail level tables are still in the eBay Web Services guide. They will be moved to the Input/Output Reference in a future release.)

Note that DetailLevel is required input for GetMyMessages.

With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you do use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance.

Applicable values:

•   ReturnAll

(in) Returns all available data. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance.


(Not all values in DetailLevelCodeType apply to this field.)
ErrorLanguage string Optional Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US).
ID--- country
----- -----
de_AT Austria
de_CH Switzerland
de_DE Germany
en_AU Australia
en_CA Canada
en_GB United Kingdom
en_SG Singapore
en_US United States
es_ES Spain
fr_BE Belgium (French)
fr_CA Canada (French)
fr_FR France
it_IT Italy
nl_BE Belgium (Dutch)
nl_NL Netherlands
zh_CN China
en_IN India
en_IE Ireland
zh_HK Hong Kong

See Tags for the Identification of Languages.
MessageID string Optional In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned.

Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
OutputSelector string Optional,
repeatable: [0..*]		 You can use the OutputSelector field to restrict the data returned by this call. When you make a call such as GetItem that retrieves data from eBay, the OutputSelector field is useful for restricting the data returned. This field makes the call response easier to use, especially when a large payload would be returned. If you use the OutputSelector field, the output data will include only the fields you specified in the request. For example, if you are using GetItem and you want the item data in the response to be restricted to the ViewItemURL (the URL where a user can view the listing) and BuyItNowPrice, then within the GetItem request, specify those output fields. To use this field, see the information at the following link.

See Selecting Fields to Retrieve.
Version string Conditional The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects:
- It indicates the version of the code lists and other data that eBay should use to process your request.
- It indicates the schema version you are using.
You need to use a version that is greater than or equal to the lowest supported version.

For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using.

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

See:
    HTTP Headers (XML API Only)
    eBay Schema Versioning Strategy
    Lowest Supported Version

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

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

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

We recommend that you only use this during development and debugging. Do not use this in requests in your production code.

Applicable values:

•   High

(in) Return warnings when the application passes unrecognized or deprecated elements in a request.

•   Low

(in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified.


See Warning Level.
Call-specific Input Fields
CreateTimeFrom dateTime Conditional The starting date of the date range for the orders to retrieve.

Applicable to Half.com.
CreateTimeTo dateTime Conditional The ending date of the date range for the orders to retrieve.

Applicable to Half.com.
ListingType ListingTypeCodeType Conditional To retrieve Half.com orders, specify Half--Do not specify this field if you are retrieving eBay orders.

This field cannot be used as a listing type filter on eBay.com. If not provided, or if any value other than Half is specified, this field has no useful effect and the call retrieves eBay orders of all types. Also, you can't retrieve both eBay and Half.com orders in the same response.

Applicable values:

•   Half

(in/out) Half.com listing (item is listed on Half.com, not on eBay). You must be a registered Half.com seller to use this format.


(Not all values in ListingTypeCodeType apply to this field.)
OrderIDArray OrderIDArrayType Conditional A set of orders to retrieve.

Not applicable to Half.com.
OrderIDArray.OrderID OrderIDType (string) Conditional,
repeatable: [0..*]		 A unique identifier for an order.
OrderRole TradingRoleCodeType Conditional Filters orders based on the role of the user making the GetOrders request.

Not applicable to Half.com.

Applicable values:

•   Buyer

(in/out) Acting as buyer.

•   CustomCode

(in/out) Reserved for future use.

•   Seller

(in/out) Acting as seller. For GetOrders, you can use this value to limit orders to those where the calling user is the seller.
OrderStatus OrderStatusCodeType Conditional Filters the returned orders by order status (Active or Completed). To retrieve orders with a status of Inactive or Cancelled, you must specify the order IDs (OrderIDArray.OrderID). When you specify OrderIDArray.OrderID, no other filters are used.

For Half.com, you can get some, but not all orders. Orders on Half.com have different order status values from eBay orders. When you set ListingType to Half, set OrderStatus to Shipped. Otherwise, GetOrders may return incomplete information or have indeterminate results.

Applicable values:

•   Active

(in/out) The cart is active. Items can only be added, deleted, or updated in the cart when status is Active.

•   Completed

(in/out) The order is completed.

•   Shipped

(in/out) The order was shipped. Half.com users can specify this in the GetOrders input.


(Not all values in OrderStatusCodeType apply to this field.)
Pagination PaginationType Optional Not applicable to eBay.com. Applicable to Half.com. If many orders are available, you may need to call GetOrders multiple times to retrieve all the data. Each result set is returned as a page of entries. Use this Pagination information to indicate the maximum number of entries to retrieve per page (i.e., per call), the page number to retrieve, and other data.
Pagination.EntriesPerPage int Optional Specifies the maximum number of entries to return in a single call. If the number of entries that can be returned is less than the value in EntriesPerPage, then the lower number is returned. For most calls, the max is 200 and the default is 25. For GetUserDisputes, the value is hard-coded at 200, and any input is ignored. For GetProducts, the maximum is 20 (and higher values are ignored). See the annotations for other individual calls to determine the correct max and default values. For GetOrders, not applicable to eBay.com (but applicable to Half.com for GetOrders).
Pagination.PageNumber int Optional Specifies the number of the page of data to return in the current call. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for other individual calls to determine the correct default value. For GetOrders, not applicable to eBay.com (for GetOrders, applicable to Half.com).
Min: 1. Default: 1.



Back to top

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

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

See also Samples.

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

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls). 

<?xml version="1.0" encoding="utf-8"?>
<GetOrdersResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType 
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType 
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
  <!-- Call-specific Output Fields -->
  <HasMoreOrders> boolean </HasMoreOrders>
  <OrderArray> OrderArrayType 
    <Order> OrderType 
      <AdjustmentAmount currencyID="CurrencyCodeType"> AmountType (double) </AdjustmentAmount>
      <AmountPaid currencyID="CurrencyCodeType"> AmountType (double) </AmountPaid>
      <AmountSaved currencyID="CurrencyCodeType"> AmountType (double) </AmountSaved>
      <BuyerUserID> UserIDType (string) </BuyerUserID>
      <CheckoutStatus> CheckoutStatusType 
        <eBayPaymentStatus> PaymentStatusCodeType </eBayPaymentStatus>
        <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled>
        <LastModifiedTime> dateTime </LastModifiedTime>
        <PaymentMethod> BuyerPaymentMethodCodeType </PaymentMethod>
        <Status> CompleteStatusCodeType </Status>
      </CheckoutStatus>
      <CreatedTime> dateTime </CreatedTime>
      <CreatingUserRole> TradingRoleCodeType </CreatingUserRole>
      <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled>
      <OrderID> OrderIDType (string) </OrderID>
      <OrderStatus> OrderStatusCodeType </OrderStatus>
      <PaidTime> dateTime </PaidTime>
      <PaymentMethods> BuyerPaymentMethodCodeType </PaymentMethods>
      <!-- ... more PaymentMethods nodes here ... -->
      <ShippedTime> dateTime </ShippedTime>
      <ShippingAddress> AddressType 
        <AddressID> string </AddressID>
        <AddressOwner> AddressOwnerCodeType </AddressOwner>
        <CityName> string </CityName>
        <Country> CountryCodeType </Country>
        <CountryName> string </CountryName>
        <ExternalAddressID> string </ExternalAddressID>
        <Name> string </Name>
        <Phone> string </Phone>
        <PostalCode> string </PostalCode>
        <StateOrProvince> string </StateOrProvince>
        <Street1> string </Street1>
        <Street2> string </Street2>
      </ShippingAddress>
      <ShippingDetails> ShippingDetailsType 
        <CODCost currencyID="CurrencyCodeType"> AmountType (double) </CODCost>
        <GetItFast> boolean </GetItFast>
        <InsuranceFee currencyID="CurrencyCodeType"> AmountType (double) </InsuranceFee>
        <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
        <InsuranceWanted> boolean </InsuranceWanted>
        <InternationalShippingServiceOption> InternationalShippingServiceOptionsType 
          <ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
          <ShippingService> token </ShippingService>
          <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
          <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
          <ShippingServicePriority> int </ShippingServicePriority>
          <ShipToLocation> string </ShipToLocation>
          <!-- ... more ShipToLocation nodes here ... -->
        </InternationalShippingServiceOption>
        <!-- ... more InternationalShippingServiceOption nodes here ... -->
        <SalesTax> SalesTaxType 
          <SalesTaxAmount currencyID="CurrencyCodeType"> AmountType (double) </SalesTaxAmount>
          <SalesTaxPercent> float </SalesTaxPercent>
          <SalesTaxState> string </SalesTaxState>
          <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
        </SalesTax>
        <SellingManagerSalesRecordNumber> int </SellingManagerSalesRecordNumber>
        <ShippingServiceOptions> ShippingServiceOptionsType 
          <ExpeditedService> boolean </ExpeditedService>
          <ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
          <ShippingService> token </ShippingService>
          <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
          <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
          <ShippingServicePriority> int </ShippingServicePriority>
        </ShippingServiceOptions>
        <!-- ... more ShippingServiceOptions nodes here ... -->
      </ShippingDetails>
      <ShippingServiceSelected> ShippingServiceOptionsType 
        <ExpeditedService> boolean </ExpeditedService>
        <ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
        <ShippingService> token </ShippingService>
        <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
        <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
        <ShippingServicePriority> int </ShippingServicePriority>
      </ShippingServiceSelected>
      <Subtotal currencyID="CurrencyCodeType"> AmountType (double) </Subtotal>
      <Total currencyID="CurrencyCodeType"> AmountType (double) </Total>
      <TransactionArray> TransactionArrayType 
        <Transaction> TransactionType 
          <Buyer> UserType 
            <Email> string </Email>
          </Buyer>
          <CreatedDate> dateTime </CreatedDate>
          <ExternalTransaction> ExternalTransactionType 
            <ExternalTransactionID> string </ExternalTransactionID>
            <ExternalTransactionTime> dateTime </ExternalTransactionTime>
            <FeeOrCreditAmount currencyID="CurrencyCodeType"> AmountType (double) </FeeOrCreditAmount>
            <PaymentOrRefundAmount currencyID="CurrencyCodeType"> AmountType (double) </PaymentOrRefundAmount>
          </ExternalTransaction>
          <!-- ... more ExternalTransaction nodes here ... -->
          <Item> ItemType 
            <AttributeArray> AttributeArrayType 
              <Attribute attributeLabel="string"> AttributeType 
                <Value> ValType 
                  <ValueLiteral> string </ValueLiteral>
                </Value>
                <!-- ... more Value nodes here ... -->
              </Attribute>
              <!-- ... more Attribute nodes here ... -->
            </AttributeArray>
            <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled>
            <ItemID> ItemIDType (string) </ItemID>
            <PrivateNotes> string </PrivateNotes>
            <SellerInventoryID> string </SellerInventoryID>
            <SKU> SKUType (string) </SKU>
            <Title> string </Title>
          </Item>
          <ListingCheckoutRedirectPreference> ListingCheckoutRedirectPreferenceType 
            <SellerThirdPartyUsername> string </SellerThirdPartyUsername>
          </ListingCheckoutRedirectPreference>
          <QuantityPurchased> int </QuantityPurchased>
          <RefundArray> RefundArrayType 
            <Refund> RefundType 
              <RefundFromSeller currencyID="CurrencyCodeType"> AmountType (double) </RefundFromSeller>
              <RefundTime> dateTime </RefundTime>
              <TotalRefundToBuyer currencyID="CurrencyCodeType"> AmountType (double) </TotalRefundToBuyer>
            </Refund>
            <!-- ... more Refund nodes here ... -->
          </RefundArray>
          <ShippedTime> dateTime </ShippedTime>
          <Status> TransactionStatusType 
            <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled>
            <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
            <PaymentMethodUsed> BuyerPaymentMethodCodeType </PaymentMethodUsed>
          </Status>
          <TransactionID> string </TransactionID>
          <TransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </TransactionPrice>
        </Transaction>
        <!-- ... more Transaction nodes here ... -->
      </TransactionArray>
    </Order>
    <!-- ... more Order nodes here ... -->
  </OrderArray>
  <OrdersPerPage> int </OrdersPerPage>
  <PageNumber> int </PageNumber>
  <PaginationResult> PaginationResultType 
    <TotalNumberOfEntries> int </TotalNumberOfEntries>
    <TotalNumberOfPages> int </TotalNumberOfPages>
  </PaginationResult>
  <ReturnedOrderCountActual> int </ReturnedOrderCountActual>
</GetOrdersResponse>
Return Value Type Occurrence Meaning
Standard Output Fields   [Jump to call-specific fields]
Ack AckCodeType Always A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Failure

(out) Request processing failed

•   Success

(out) Request processing succeeded

•   Warning

(out) Request processing completed with warning information being included in the response message


(Not all values in AckCodeType apply to this field.)
Build string Always This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID string Conditionally In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned.

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

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

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   RequestError

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

•   SystemError

(out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
Errors.ErrorCode token Conditionally A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document.
Errors.ErrorParameters ErrorParameterType Conditionally,
repeatable: [0..*]		 This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters
  [ attribute ParamID ]		 string Conditionally The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value string Conditionally The value of the variable (e.g., the attribute set ID)
Errors.LongMessage string Conditionally A more detailed description of the condition that raised the error.
Errors.SeverityCode SeverityCodeType Conditionally Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use

•   Error

(out) Application-level error

•   Warning

(out) Warning or informational error
Errors.ShortMessage string Conditionally A brief description of the condition that raised the error.
HardExpirationWarning string Conditionally Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp dateTime Always This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone.

Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version string Always The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.
Call-specific Output Fields
HasMoreOrders boolean Always Applies only to Half.com. If true, there are more orders yet to be retrieved. Additional GetOrders calls with higher page numbers or more entries per page must be made to retrieve these orders. If false, no more orders are available or no orders match the request (based on the input filters).
OrderArray OrderArrayType Always The set of orders that match the order IDs or filter criteria specified. Also applicable to Half.com (only returns orders that have not been marked as shipped).
OrderArray.Order OrderType Always,
repeatable: [1..*]		 Also applicable to Half.com.

See Working with Combined Payment.
OrderArray.Order
  .AdjustmentAmount 		AmountType (double) Always Amount by which the buyer is adjusting the order total. Used when the seller has not supplied payment details such as shipping and handling or insurance fee. Also applicable to Half.com (for GetOrders).
OrderArray.Order
  .AdjustmentAmount
  [ attribute currencyID ]		 CurrencyCodeType Always Currency in which the monetary amount is specified.

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

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order.AmountPaid AmountType (double) Always Amount the buyer has paid the seller for the order. For GetOrders, applies only to Half.com.
OrderArray.Order.AmountPaid
  [ attribute currencyID ]		 CurrencyCodeType Always Currency in which the monetary amount is specified.

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

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order.AmountSaved AmountType (double) Always Amount the buyer saved by having multiple items combined into a single order, versus purchasing the items separately.
OrderArray.Order.AmountSaved
  [ attribute currencyID ]		 CurrencyCodeType Always Currency in which the monetary amount is specified.

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

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order.BuyerUserID UserIDType (string) Always User ID of the order's buyer. Not applicable to Half.com.
OrderArray.Order
  .CheckoutStatus 		CheckoutStatusType Always The current checkout status of the order. Also applicable to Half.com (for GetOrders).
OrderArray.Order
  .CheckoutStatus
  .eBayPaymentStatus 		PaymentStatusCodeType Always Indicates the success or failure of a buyer's online payment. Also applicable to Half.com (for GetOrders).

Applicable values:

•   BuyerCreditCardFailed

(out) The buyer's credit card failed.

•   BuyerECheckBounced

(out) The buyer's eCheck bounced.

•   BuyerFailedPaymentReportedBySeller

(out) The seller reports that the buyer's payment failed.

•   CustomCode

(out) Reserved for internal or future use.

•   NoPaymentFailure

(out) No payment failure.

•   PaymentInProcess

(out) Currently for eBay Germany only.

•   PayPalPaymentInProcess

(out) The payment from buyer to seller is in PayPal process, but has not yet been completed.
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.
OrderArray.Order
  .CheckoutStatus
  .LastModifiedTime 		dateTime Always The time the status was last modified. Also applicable to Half.com (for GetOrders).
OrderArray.Order
  .CheckoutStatus.PaymentMethod 		BuyerPaymentMethodCodeType Always The payment method the buyer uses to purchase the item. Also applicable to Half.com (for GetOrders).

Applicable values: See PaymentMethod.
OrderArray.Order
  .CheckoutStatus.Status 		CompleteStatusCodeType Always The status of the order. Also applicable to Half.com (for GetOrders).

Applicable values:

•   Complete

(in/out) Transaction is complete.

•   CustomCode

(in/out) Reserved for internal or future use

•   Incomplete

(in/out) Transaction is incomplete.

•   Pending

(in/out) Transaction is pending.
OrderArray.Order.CreatedTime dateTime Always Date and time the order was created. Also applicable to Half.com (for GetOrders).
OrderArray.Order
  .CreatingUserRole 		TradingRoleCodeType Always Indicates whether the order is created by the buyer or by the seller.

Applicable values:

•   Buyer

(in/out) Acting as buyer.

•   CustomCode

(in/out) Reserved for future use.

•   Seller

(in/out) Acting as seller. For GetOrders, you can use this value to limit orders to those where the calling user is the seller.
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.
OrderArray.Order.OrderID OrderIDType (string) Always Unique identifier that eBay generates for the order.

For calls like GetItemTransactions (and the Checkout notification), no OrderID will appear when only 1 item is purchased in a single end-to-end checkout flow (because the transaction would not be part of an order in this case).

Also applicable to Half.com (for GetOrders).
OrderArray.Order.OrderStatus OrderStatusCodeType Always The current status of the order.

Also applicable to Half.com (for GetOrders).

Applicable values:

•   Active

(in/out) The cart is active. Items can only be added, deleted, or updated in the cart when status is Active.

•   Authenticated

(out) The cart was authenticated.

•   Cancelled

(out) The cart was cancelled.

•   Completed

(in/out) The order is completed.

•   CustomCode

(out) Reserved for internal or future use.

•   Default

(out) Default status.

•   Inactive

(out) The cart is invalid; it does not exist. An example is a cart that has expired.

•   InProcess

(out) After placing the order and before completion of checkout, the card is "in process."

•   Invalid

(out) Invalid.

•   Shipped

(in/out) The order was shipped. Half.com users can specify this in the GetOrders input.
OrderArray.Order.PaidTime dateTime Conditionally Date and time the order was paid. This time is specified in GMT (not Pacific time). See "Time Values" in the eBay Web Services guide for information about converting between GMT and other time zones. Also applicable to Half.com (for GetOrders).
OrderArray.Order
  .PaymentMethods 		BuyerPaymentMethodCodeType Always,
repeatable: [1..*]		 The payment methods the buyer uses to pay for the order. An order can have multiple payment methods if the buyer combines several transactions into one order. Also applicable to Half.com (for GetOrders).

Applicable values: See PaymentMethods.
OrderArray.Order.ShippedTime dateTime Conditionally Date and time the order was shipped. This time is specified in GMT (not Pacific time). See "Time Values" in the eBay Web Services guide for information about converting between GMT and other time zones. Also applicable to Half.com (for GetOrders).
OrderArray.Order
  .ShippingAddress 		AddressType Always Shipping address the order has been or will be sent to. Also applicable to Half.com (for GetOrders).
OrderArray.Order
  .ShippingAddress.AddressID 		string Always ID assigned to the address in the eBay database. For GetOrders, applies only to Half.com.
OrderArray.Order
  .ShippingAddress.AddressOwner 		AddressOwnerCodeType Always 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.
OrderArray.Order
  .ShippingAddress.CityName 		string Always The name of the user's city. Also applicable to Half.com (for GetOrders).
Max length: 64.
OrderArray.Order
  .ShippingAddress.Country 		CountryCodeType Always The country code of the user.

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

Also applicable to Half.com (for GetOrders).

Applicable values: See Country.
OrderArray.Order
  .ShippingAddress.CountryName 		string Always The name of the user's country. Also applicable to Half.com (for GetOrders).
OrderArray.Order
  .ShippingAddress
  .ExternalAddressID 		string Always ID assigned to the address by the owner of the address (fitting only if the address is owned by PayPal; see AddressOwner). Also applicable to Half.com (for GetOrders).
Max length: 20.
OrderArray.Order
  .ShippingAddress.Name 		string Always User's name for the address. Also applicable to Half.com (for GetOrders).
Max length: 64.
OrderArray.Order
  .ShippingAddress.Phone 		string Always User's primary phone number. This may return a value of "Invalid Request" if you are not authorized to see the user's phone number. Also applicable to Half.com (for GetOrders).
OrderArray.Order
  .ShippingAddress.PostalCode 		string Always User's postal code.

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

Also applicable to Half.com (for GetOrders).
Max length: 12.
OrderArray.Order
  .ShippingAddress
  .StateOrProvince 		string Always The region of the user's address. Also applicable to Half.com (for GetOrders).
Max length: 64.
OrderArray.Order
  .ShippingAddress.Street1 		string Always Line 1 of the user's street address. Also applicable to Half.com (for GetOrders).
Max length: 100.
OrderArray.Order
  .ShippingAddress.Street2 		string Always Line 2 of the user's address (such as an apartment number). Returned if the user specified a second street value for their address. Also applicable to Half.com (for GetOrders).
In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable).
Max length: 100.
OrderArray.Order
  .ShippingDetails 		ShippingDetailsType Always The shipping-related details for an item or transaction, including flat or calculated shipping costs and shipping insurance costs. Also applicable to Half.com (for GetOrders).
OrderArray.Order
  .ShippingDetails.CODCost 		AmountType (double) Conditionally Valid only for the Italy site (site ID 101); contains the cash-on-delivery (COD) cost for COD shipping.

See Specifying the Cash on Delivery Option in Shipping Details.
OrderArray.Order
  .ShippingDetails.CODCost
  [ attribute currencyID ]		 CurrencyCodeType Always Currency in which the monetary amount is specified.

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

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingDetails.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.
OrderArray.Order
  .ShippingDetails.InsuranceFee 		AmountType (double) Always Cost of shipping insurance set by the seller. If the buyer bought more than one of this item, this is the insurance for just a single item. Exception: for GetItemShipping, this is proportional to QuantitySold. Value should be greater than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. Optional as input and only allowed if ChangePaymentInstructions is true. This field is ignored when InsuranceOption is not specified in the request.

Valid only on the following sites: AU, FR, and IT
Applicable to Half.com for GetOrders.
Default: 0.00.
OrderArray.Order
  .ShippingDetails.InsuranceFee
  [ attribute currencyID ]		 CurrencyCodeType Always Currency in which the monetary amount is specified.

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

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingDetails
  .InsuranceOption 		InsuranceOptionCodeType Always Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Optional as input and only allowed if ChangePaymentInstructions is true. If this field is not included in the request, values specified in the InsuranceFee field will be ignored.

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

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

Applicable to Half.com

Applicable values:

•   CustomCode

(in/out) Reserved for internal or future use

•   IncludedInShippingHandling

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

•   NotOffered

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

•   NotOfferedOnSite

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

•   Optional

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

•   Required

(in/out) The seller requires that the buyer pay for shipping insurance.
OrderArray.Order
  .ShippingDetails
  .InsuranceWanted 		boolean Always Whether or not the buyer selected to pay for insurance as an option offered by the seller. This only has a value after the buyer has gone through checkout and selected the insurance preference.

Valid only on the following sites: AU, FR, and IT
Applicable to Half.com for GetOrders.
OrderArray.Order
  .ShippingDetails
  .InternationalShippingServiceOption 		InternationalShippingServiceOptionsType Conditionally,
repeatable: [0..*]		 Shipping costs and options related to an international shipping service. If used, at least one domestic shipping service must also be provided in ShippingServiceOptions.

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

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

A seller can offer up to three domestic shipping services and up to three international shipping services. All domestic services must be the same shipping type (for example, Flat versus Calculated); the same is true for international shipping services offered by the seller.

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

See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1).
OrderArray.Order
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingInsuranceCost 		AmountType (double) Conditionally The insurance cost associated with shipping a single item with this shipping service. Exception: for GetItemShipping, this is proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only.

Valid only on the following sites: AU, FR, and IT
Also applicable to Half.com (for GetOrders).

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

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

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

See GeteBayDetails.



Applicable values: See ShippingServiceCodeType
OrderArray.Order
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceAdditionalCost 		AmountType (double) Conditionally Cost of shipping each additional item beyond the first item. Should be zero for single-item listings. Default value is 0.00. For flat shipping only.
OrderArray.Order
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally Currency in which the monetary amount is specified.

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

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

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

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

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServicePriority 		int Conditionally Seller-preferred presentation order relative to other service options. Valid values are: 1, 2 and 3 (first, second and third choices). For flat and calculated shipping.
OrderArray.Order
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShipToLocation 		string Conditionally,
repeatable: [0..*]		 An international location or region to where the item seller will ship the item. Use GeteBayDetails to determine which locations are valid per site. These values are string equivalents of values found in ShippingRegionCodeType and CountryCodeType. For the AddItem family of calls, this field is required if any international shipping service is specified.

See ShipToLocation.



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

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

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

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

Applicable to Half.com (for GetOrders).
OrderArray.Order
  .ShippingDetails.SalesTax
  .SalesTaxAmount
  [ attribute currencyID ]		 CurrencyCodeType Always Currency in which the monetary amount is specified.

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

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

Applicable to Half.com (for GetOrders).
OrderArray.Order
  .ShippingDetails.SalesTax
  .SalesTaxState 		string Always State or jurisdiction for which the sales tax is being collected. Only returned if the seller specified a value.

Applicable to Half.com (for GetOrders).
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).
OrderArray.Order
  .ShippingDetails
  .SellingManagerSalesRecordNumber 		int Conditionally The sale record ID. Applicable to Selling Manager users. When an item is sold, Selling Manager generates a sale record. A sale record contains buyer information, shipping, and other information. A sale record is displayed in the Sold view in Selling Manager. Each sale record has a sale record ID. In the following calls, the value for the sale record ID is in the SellingManagerSalesRecordNumber field: GetItemTransactions, GetSellerTransactions, GetOrders, GetOrderTransactions. In the Selling Manager calls, the value for the sale record ID is in the SaleRecordID field. The sale record ID can be for one transaction or for an order (which contains multiple transactions).
Applicable to Half.com (for GetOrders).
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions 		ShippingServiceOptionsType Conditionally,
repeatable: [0..*]		 Shipping costs and options related to domestic shipping services offered by the seller. Flat and calculated shipping. Required if InternationalShippingServiceOption is specified.

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

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

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

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

A seller can offer up to three domestic shipping services and up to three international shipping services. All domestic services must be the same shipping type (for example, Flat versus Calculated); the same is true for international shipping services offered by the seller.

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

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

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

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

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

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

See GeteBayDetails.



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

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

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

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

Also applicable to Half.com (for GetOrders).

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

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

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServicePriority 		int Conditionally Seller-preferred presentation order relative to other service options. Valid values: 1 (1st choice), 2 (2nd choice), 3 (3rd choice). For flat and calculated shipping. Not applicable to Half.com.
OrderArray.Order
  .ShippingServiceSelected 		ShippingServiceOptionsType Always The shipping service selected by the buyer from the services offered by the seller. Also applicable to Half.com (for GetOrders).
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.
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).

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

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

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

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

See GeteBayDetails.



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

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

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

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

Also applicable to Half.com (for GetOrders).

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

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

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingServiceSelected
  .ShippingServicePriority 		int Conditionally Seller-preferred presentation order relative to other service options. Valid values: 1 (1st choice), 2 (2nd choice), 3 (3rd choice). For flat and calculated shipping. Not applicable to Half.com.
OrderArray.Order.Subtotal AmountType (double) Always The sum of the sale prices of all of the transactions in the order, where a transaction sale price is the item sale price times the quantity sold. Also applicable to Half.com (for GetOrders).
OrderArray.Order.Subtotal
  [ attribute currencyID ]		 CurrencyCodeType Always Currency in which the monetary amount is specified.

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

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order.Total AmountType (double) Always Subtotal plus the shipping cost plus the sales tax plus cost of insurance. Also applicable to Half.com (for GetOrders).
OrderArray.Order.Total
  [ attribute currencyID ]		 CurrencyCodeType Always Currency in which the monetary amount is specified.

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

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray 		TransactionArrayType Always The set of two or more transactions that make up the order. Also applicable to Half.com (for GetOrders).

We strongly recommend that you avoid mixing transactions for digital and non-digital listings in the same order. (In the future, AddOrder may enforce this recommendation.)
OrderArray.Order
  .TransactionArray.Transaction 		TransactionType Always,
repeatable: [1..*]		 Information about one transaction. Also applicable to Half.com (for GetOrders).

See Working with Combined Payment.
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer 		UserType Conditionally Contains the data for the transaction's buyer. See UserType for its child elements. Returned by GetItemsAwaitingFeedback if Seller is making the request.

Applicable to Half.com (for GetOrders only).
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer.Email 		string Conditionally Email address for the user. You cannot retrieve an email address for any user with whom you do not have a transactional relationship, regardless of site. Email is only returned for applicable calls when you are retrieving your own user data OR when you and the other user are in a transactional relationship and the call is being executed within a certain amount of time after the transaction is created. Based on Trust and Safety policies, the time is unspecified and can vary by site.

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

See Working with Anonymous User Information.
OrderArray.Order
  .TransactionArray.Transaction
  .CreatedDate 		dateTime Always Indicates when the transaction was created. For fixed-price, Stores, and BIN items this indicates when the purchase (or BIN) occurred. For competitive-bid item listing types this indicates when listing ended, the winning bidder(s) determined, and the transaction created.

Applicable to Half.com (for GetOrders only).
OrderArray.Order
  .TransactionArray.Transaction
  .ExternalTransaction 		ExternalTransactionType Conditionally,
repeatable: [0..*]		 A PayPal transaction that relates to this eBay transaction. Returned only if there is at least one PayPal transaction related to this eBay transaction.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .ExternalTransaction
  .ExternalTransactionID 		string Conditionally Unique payment transaction ID.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .ExternalTransaction
  .ExternalTransactionTime 		dateTime Conditionally Date on which transaction occurs.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .ExternalTransaction
  .FeeOrCreditAmount 		AmountType (double) Conditionally

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .ExternalTransaction
  .FeeOrCreditAmount
  [ attribute currencyID ]		 CurrencyCodeType Always Currency in which the monetary amount is specified.

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

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .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. Also returned if DetailLevel is not provided on input.
OrderArray.Order
  .TransactionArray.Transaction
  .ExternalTransaction
  .PaymentOrRefundAmount
  [ attribute currencyID ]		 CurrencyCodeType Always Currency in which the monetary amount is specified.

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

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .Item 		ItemType Always Information about the item that spawned the transaction. It is a purchase from this item's listing that the transaction represents. To remove a property from an item, specify it in ModifyType as a changed property, but do not give it a value in Item.

Applicable to Half.com (for GetOrders).
OrderArray.Order
  .TransactionArray.Transaction
  .Item.AttributeArray 		AttributeArrayType Always Used to specify the item condition in AddItem. Only applicable to Half.com (not eBay listings). You can revise this property for Half.com listings. For Half.com, AddItem does not use the same Attributes format as eBay's Item Specifics.

Not returned in GetItem. See AttributeSetArray instead.

See:
    Half.com
    (GetItem) Item.AttributeSetArray

OrderArray.Order
  .TransactionArray.Transaction
  .Item.AttributeArray.Attribute 		AttributeType Always,
repeatable: [1..*]		 Only applicable to Half.com. Not applicable to eBay listings. You can revise this field for Half.com listings.
OrderArray.Order
  .TransactionArray.Transaction
  .Item.AttributeArray.Attribute
  [ attribute attributeLabel ]		 string Always Name of the attribute being specified. This is not part of eBay's standard Item Specifics format (i.e., there is no relationship to GetAttributesCS). For GetCategoryListings, this returns the value "Condition" to identify the item condition attribute. For GetOrders, this is always returned for Half.com orders. (It is not applicable to orders on the eBay.com site.) For Half.com, see the eBay Web Services Guide for valid input values. For Half.com, this field is required when you use AddItem. You can revise this value for Half.com listings.
OrderArray.Order
  .TransactionArray.Transaction
  .Item.AttributeArray.Attribute
  .Value 		ValType Always,
repeatable: [1..*]		 A value the seller selected or entered for the attribute. At least one value is required for each Attribute that you specify. Some attributes can have multiple values. See the eBay Web Services guide sections on Item Specifics (Attributes) and Pre-filled Item Information (Catalogs) for information about using GetAttributesCS to determine valid attribute values.

For eBay.com listings, use AttributeSetArray.AttributeSet.Attribute.Value. For Half.com, use AttributeArray.Attribute.Value. That is, the parent elements and usage for Half.com differs from eBay's standard Item Specifics format (and there is no relationship to GetAttributesCS). For Half.com, this does not use the same Attributes logic as eBay's Item Specifics. For Half.com, AttributeArray.Attribute.Value is required when you use AddItem. see the eBay Web Services Guide for valid values. You can revise AttributeArray.Attribute.Value for Half.com listings.
OrderArray.Order
  .TransactionArray.Transaction
  .Item.AttributeArray.Attribute
  .Value.ValueLiteral 		string Always The descriptive name of an attribute or characteristic value (e.g., "New" might be a literal value for a Condition attribute). In item-listing requests, if you send ValueID with an id of -3 or -6, you must use ValueLiteral to enter the value the user specified. Otherwise, eBay treats the request as if no value was sent at all. For eBay.com listings, use AttributeSetArray.AttributeSet.Attribute.Value.ValueLiteral. The max length allowed varies per attribute.

For GetSearchResults requests (in SearchRequest), only use ValueLiteral for attributes that support free-text values. That is, if eBay defines a value name and a unique value ID for an attribute in GetProductFinder, do not pass the name in ValueLiteral (because it won't work). Instead, specify the unique value ID in ValueID.

For Half.com, use AttributeArray.Attribute.Value.ValueLiteral in listing requests. That is, the parent elements and usage for Half.com differs from eBay's standard Item Specifics format (and there is no relationship to GetAttributesCS). For Half.com, AttributeArray.Attribute.Value.ValueLiteral is required when you use AddItem. See the eBay Web Services Guide for valid values. For the Half.com Notes attribute, the max length is 500 characters. You can revise AttributeArray.Attribute.Value.ValueLiteral for Half.com listings.
Max length: see description.
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).
OrderArray.Order
  .TransactionArray.Transaction
  .Item.ItemID 		ItemIDType (string) Always The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value.

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

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

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

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

Note: Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. eBay will increase the size of IDs over time. Your code should be prepared to handle IDs of up to 19 digits. For more information about item IDs, see Common FAQs on eBay Item IDs and other eBay IDs in the Knowledge Base.
Max length: 19 (Note: the eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).
OrderArray.Order
  .TransactionArray.Transaction
  .Item.PrivateNotes 		string Conditionally A note a user makes on an item in their My eBay account. The note is prefaced with the words My Note. For eBay.com, only GetMyeBayBuying and GetMyeBaySelling (not GetItem) return this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note.

Not supported as input in ReviseItem. Use SetUserNotes instead

For GetMyeBayBuying In WatchList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID (if no purchases) or ItemID and VariationSpecifics (if there are purchases) in SetUserNotes (or selected the equivalent in the My eBay UI on the site).

In WonList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID and TransactionID in SetUserNotes (or selected the equivalent in the My eBay UI on the site).

Not applicable to Half.com (instead, use Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.)
OrderArray.Order
  .TransactionArray.Transaction
  .Item.SellerInventoryID 		string Conditionally Unique identifier for a Half.com item. Must be an alphanumeric value (with no symbols) that is unique across the seller's active (unsold) inventory on Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing. Only returned from GetOrders if the seller specified a value when the item was listed. You cannot revise this field.

Not applicable to eBay.com listings.
Max length: 100.
OrderArray.Order
  .TransactionArray.Transaction
  .Item.SKU 		SKUType (string) Conditionally A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. A seller can specify a SKU when listing an item with AddItem and related calls. eBay preserves the SKU on the item, enabling you to obtain it before and after a transaction is created. (SKU is recommended as an alternative to ApplicationData.)

A SKU is not required to be unique. A seller can specify a particular SKU on one item or on multiple items. Different sellers can use the same SKUs.

If the SKU is unique across a seller's active listings, and if the seller listed the item by using AddFixedPriceItem or RelistFixedPriceItem, the seller can also set Item.InventoryTrackingMethod to SKU in those calls. This allows the seller to use SKU instead of ItemID as a unique identifier in subsequent calls, such as GetItem and ReviseInventoryStatus. If both ItemID and SKU are specified in calls that support the use of SKU as a unique identifier, the ItemID value takes precedence.

For multi-variation listings, the SKU can be used to uniquely identify a variation that is being revised or relisted. If InventoryTrackingMethod is ItemID, an ItemID is also required. When both SKU and VariationSpecifics are passed in the request, the variation specifics take precedence as the unique identifier.

Note: The eBay Web site UI cannot identify listings by SKU. For example, My eBay pages and Search pages all identify listings by item ID. When a buyer contacts you via eBay's messaging functionality, eBay uses the item ID as the identifier. Buyer-focused APIs (like the Shopping API) also do not support SKU as an identifier. For revising and relisting only: To remove a SKU when you revise or relist an item, use DeletedField. (You cannot remove a SKU when Item.InventoryTrackingMethod is set to SKU.)

For GetMyeBaySelling, this is only returned if set.
Not applicable to Half.com.
Max length: 50.

See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem.
OrderArray.Order
  .TransactionArray.Transaction
  .Item.Title 		string Always Name of the item as it appears in the listing or search results. Required for most items. Optional if you list in Books, Music, Movies, or Video Games categories and you use Pre-filled Item Information (as the title can be pre-filled based on the catalog product title). That is, optional if you specify Item.ExternalProductID or Item.ProductListingDetails.

You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.)

For AddItem, not applicable to Half.com. For GetOrders, not returned from eBay.com, but a title from the Half.com catalog is returned from Half.com instead.

You can add or change the value of this tag only if an item has no bids (or no items have sold) and the listing does not end for 12 hours.

In GetItemRecommendations, more keywords in the title usually results in more relevant recommendations.
Max length: 55.
OrderArray.Order
  .TransactionArray.Transaction
  .ListingCheckoutRedirectPreference 		ListingCheckoutRedirectPreferenceType Conditionally ProStores listing level preferences regarding the store to which checkout should be redirected for the listing if ThirdPartyCheckout is true.

See Third Party Checkout Redirect to ProStores.
OrderArray.Order
  .TransactionArray.Transaction
  .ListingCheckoutRedirectPreference
  .SellerThirdPartyUsername 		string Conditionally The user name of the associated store, if ThirdPartyCheckout is true. To remove this value when revising or relisting an item, use DeletedField.
Max length: 200.
OrderArray.Order
  .TransactionArray.Transaction
  .QuantityPurchased 		int Always Indicates the number of items the buyer purchased from the listing identified in ItemID.

Applicable to Half.com (for GetOrders).
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray 		RefundArrayType Conditionally Contains an array of refunds. Applicable to Half.com (for GetOrders).
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund 		RefundType Conditionally,
repeatable: [0..*]		 Contains information about one refund. Applicable to Half.com (for GetOrders).
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund
  .RefundFromSeller 		AmountType (double) Conditionally Total amount refunded by the seller for this transaction. Applicable to Half.com (for GetOrders).
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund
  .RefundFromSeller
  [ attribute currencyID ]		 CurrencyCodeType Always Currency in which the monetary amount is specified.

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

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund.RefundTime 		dateTime Conditionally The date and time at which the refund was issued. Applicable to Half.com (for GetOrders).
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund
  .TotalRefundToBuyer 		AmountType (double) Conditionally Total amount refunded to the buyer for this transaction. Applicable to Half.com (for GetOrders).
OrderArray.Order
  .TransactionArray.Transaction
  .RefundArray.Refund
  .TotalRefundToBuyer
  [ attribute currencyID ]		 CurrencyCodeType Always Currency in which the monetary amount is specified.

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

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippedTime 		dateTime Always Indicates the time when the item(s) associated with the transaction were marked as shipped, if known. The value is set when the seller uses shipment tracking features offered by eBay or an eBay partner. This value is also set when the seller marks the item as shipped by using CompleteSale. If the seller is a Selling Manager Pro user, they can also mark the item as shipped by using My eBay. Note that this value is only visible if the request user is the buyer or seller associated with the transaction.

Applicable to Half.com (for GetOrders only).
OrderArray.Order
  .TransactionArray.Transaction
  .Status 		TransactionStatusType Conditionally Contains the status of the transaction, such as the buyer's online payment and whether the checkout process for the transaction has been completed. See TransactionStatusType for its child elements.

Not applicable to Half.com.
OrderArray.Order
  .TransactionArray.Transaction
  .Status
  .IntegratedMerchantCreditCardEnabled 		boolean Always 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.
OrderArray.Order
  .TransactionArray.Transaction
  .Status.PaymentHoldStatus 		PaymentHoldStatusCodeType Conditionally Contains the current status of a hold on a PayPal payment. The payment hold that is referred to as a "payment review" hold results from a possible issue with a buyer. The payment hold referred to as a "merchant hold" results from a possible issue with a seller. For more information, please see the link below. Additionally, in the cases of the GetMyeBaySelling and GetMyeBayBuying calls, the PaymentHoldStatus value can affect the value returned in in SellerPaidStatus and BuyerPaidStatus; see the PaymentHoldStatus applicable values.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   MerchantHold

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

•   None

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

•   PaymentReview

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

•   Released

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


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

Applicable values: See PaymentMethodUsed.
OrderArray.Order
  .TransactionArray.Transaction
  .TransactionID 		string Always Identifier for the transaction. A value of zero is used for the Chinese auction format. Thus, a value of zero is a valid transaction ID. A transaction ID is only unique to the listing that spawned it, so a transaction is only uniquely identified on a global basis by a combination of ItemID and TransactionID.

Applicable to Half.com (for GetOrders only).
Max length: 19 (Note: The eBay database specifies 38. Currently, transaction IDs are usually 9 to 12 digits.) .
OrderArray.Order
  .TransactionArray.Transaction
  .TransactionPrice 		AmountType (double) Always Price of the transaction (before shipping and sales tax) that the buyer needs to pay to complete the purchase. Note that for GetItemTransactions and GetSellerTransactions, TransactionPrice is the per-item price for the transaction; transactions with TransactionArray.Transaction.QuantityPurchased of more than 1 have the same value for TransactionPrice as transactions with TransactionArray.Transaction.QuantityPurchased of 1. For eBay Motors, TransactionPrice is the deposit amount.

Applicable to Half.com (for GetOrders).
OrderArray.Order
  .TransactionArray.Transaction
  .TransactionPrice
  [ attribute currencyID ]		 CurrencyCodeType Always Currency in which the monetary amount is specified.

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

For a list of possible enumeration values, see CurrencyCodeType.
OrdersPerPage int Always Applies only to Half.com. Indicates the number of orders that can be returned per page of data (i.e., per call). This is the same as the value specified in the Pagination.EntriesPerPage input (or the default value, if EntriesPerPage was not specified). This is not necessarily the actual number of orders returned per page (see ReturnedOrderCountActual).
PageNumber int Always Applies only to Half.com. Indicates which page of data holds the current result set. Will be the same as the value specified in the Pagination.PageNumber input. If orders are returned, the first page is 1.
PaginationResult PaginationResultType Always Applies only to Half.com. Contains information regarding the pagination of data (if pagination is used), including total number of pages and total number of entries.
PaginationResult
  .TotalNumberOfEntries 		int Always Indicates the total number of entries that could be returned by repeated requests. For GetOrders, not applicable to eBay.com (for GetOrders, applicable to Half.com). Returned with a value of 0 if no entries are available.
PaginationResult
  .TotalNumberOfPages 		int Always Indicates the total number of pages of data that could be returned by repeated requests. For GetOrders, not applicable to eBay.com (for GetOrders, applicable to Half.com). Returned with a value of 0 if no pages are available.
ReturnedOrderCountActual int Always Applies only to Half.com. Indicates the total number of orders returned.



Back to top

Input Output Detail Controls Samples Change History Top Errors for GetOrders
GetOrders 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.

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

Output Field none ReturnAll
HasMoreOrdersY-
OrderArrayY-
OrderArray.OrderY-
OrderArray.Order.AdjustmentAmountY-
OrderArray.Order.AmountPaidY-
OrderArray.Order.AmountSavedY-
OrderArray.Order.BuyerUserIDY-
OrderArray.Order.CheckoutStatusY-
OrderArray.Order.CheckoutStatus.eBayPaymentStatusY-
OrderArray.Order.CheckoutStatus
  .IntegratedMerchantCreditCardEnabled		Y-
OrderArray.Order.CheckoutStatus.LastModifiedTimeY-
OrderArray.Order.CheckoutStatus.PaymentMethodY-
OrderArray.Order.CheckoutStatus.StatusY-
OrderArray.Order.CreatedTimeY-
OrderArray.Order.CreatingUserRoleY-
OrderArray.Order.IntegratedMerchantCreditCardEnabledY-
OrderArray.Order.OrderIDY-
OrderArray.Order.OrderStatusY-
OrderArray.Order.PaidTime(Y)-
OrderArray.Order.PaymentMethodsY-
OrderArray.Order.ShippedTime(Y)-
OrderArray.Order.ShippingAddressY-
OrderArray.Order.ShippingAddress.AddressIDY-
OrderArray.Order.ShippingAddress.AddressOwnerY-
OrderArray.Order.ShippingAddress.CityNameY-
OrderArray.Order.ShippingAddress.CountryY-
OrderArray.Order.ShippingAddress.CountryNameY-
OrderArray.Order.ShippingAddress.ExternalAddressIDY-
OrderArray.Order.ShippingAddress.NameY-
OrderArray.Order.ShippingAddress.PhoneY-
OrderArray.Order.ShippingAddress.PostalCodeY-
OrderArray.Order.ShippingAddress.StateOrProvinceY-
OrderArray.Order.ShippingAddress.Street1Y-
OrderArray.Order.ShippingAddress.Street2Y-
OrderArray.Order.ShippingDetailsY-
OrderArray.Order.ShippingDetails.CODCost(Y)-
OrderArray.Order.ShippingDetails.GetItFastY-
OrderArray.Order.ShippingDetails.InsuranceFeeY-
OrderArray.Order.ShippingDetails.InsuranceOptionY-
OrderArray.Order.ShippingDetails.InsuranceWantedY-
OrderArray.Order.ShippingDetails
  .InternationalShippingServiceOption		(Y)-
OrderArray.Order.ShippingDetails
  .InternationalShippingServiceOption.ShippingInsuranceCost		(Y)-
OrderArray.Order.ShippingDetails
  .InternationalShippingServiceOption.ShippingService		(Y)-
OrderArray.Order.ShippingDetails
  .InternationalShippingServiceOption.ShippingServiceAdditionalCost		(Y)-
OrderArray.Order.ShippingDetails
  .InternationalShippingServiceOption.ShippingServiceCost		(Y)-
OrderArray.Order.ShippingDetails
  .InternationalShippingServiceOption.ShippingServicePriority		(Y)-
OrderArray.Order.ShippingDetails
  .InternationalShippingServiceOption.ShipToLocation		(Y)-
OrderArray.Order.ShippingDetails.SalesTaxY-
OrderArray.Order.ShippingDetails.SalesTax.SalesTaxAmountY-
OrderArray.Order.ShippingDetails.SalesTax.SalesTaxPercentY-
OrderArray.Order.ShippingDetails.SalesTax.SalesTaxStateY-
OrderArray.Order.ShippingDetails.SalesTax.ShippingIncludedInTaxY-
OrderArray.Order.ShippingDetails.SellingManagerSalesRecordNumber(Y)-
OrderArray.Order.ShippingDetails.ShippingServiceOptions(Y)-
OrderArray.Order.ShippingDetails.ShippingServiceOptions
  .ExpeditedService		(Y)-
OrderArray.Order.ShippingDetails.ShippingServiceOptions
  .ShippingInsuranceCost		(Y)-
OrderArray.Order.ShippingDetails.ShippingServiceOptions
  .ShippingService		(Y)-
OrderArray.Order.ShippingDetails.ShippingServiceOptions
  .ShippingServiceAdditionalCost		(Y)-
OrderArray.Order.ShippingDetails.ShippingServiceOptions
  .ShippingServiceCost		(Y)-
OrderArray.Order.ShippingDetails.ShippingServiceOptions
  .ShippingServicePriority		(Y)-
OrderArray.Order.ShippingServiceSelectedY-
OrderArray.Order.ShippingServiceSelected.ExpeditedService(Y)-
OrderArray.Order.ShippingServiceSelected.ShippingInsuranceCost(Y)-
OrderArray.Order.ShippingServiceSelected.ShippingService(Y)-
OrderArray.Order.ShippingServiceSelected
  .ShippingServiceAdditionalCost		(Y)-
OrderArray.Order.ShippingServiceSelected.ShippingServiceCost(Y)-
OrderArray.Order.ShippingServiceSelected.ShippingServicePriority(Y)-
OrderArray.Order.SubtotalY-
OrderArray.Order.TotalY-
OrderArray.Order.TransactionArrayY-
OrderArray.Order.TransactionArray.TransactionY-
OrderArray.Order.TransactionArray.Transaction.Buyer(Y)-
OrderArray.Order.TransactionArray.Transaction.Buyer.Email(Y)-
OrderArray.Order.TransactionArray.Transaction.CreatedDateY-
OrderArray.Order.TransactionArray.Transaction.ExternalTransaction(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.ExternalTransaction
  .ExternalTransactionID		(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.ExternalTransaction
  .ExternalTransactionTime		(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.ExternalTransaction
  .FeeOrCreditAmount		(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.ExternalTransaction
  .PaymentOrRefundAmount		(Y)(Y)
OrderArray.Order.TransactionArray.Transaction.ItemY-
OrderArray.Order.TransactionArray.Transaction.Item.AttributeArrayY-
OrderArray.Order.TransactionArray.Transaction.Item.AttributeArray
  .Attribute		Y-
OrderArray.Order.TransactionArray.Transaction.Item.AttributeArray
  .Attribute.Value		Y-
OrderArray.Order.TransactionArray.Transaction.Item.AttributeArray
  .Attribute.Value.ValueLiteral		Y-
OrderArray.Order.TransactionArray.Transaction.Item
  .IntegratedMerchantCreditCardEnabled		(Y)-
OrderArray.Order.TransactionArray.Transaction.Item.ItemIDY-
OrderArray.Order.TransactionArray.Transaction.Item.PrivateNotes(Y)-
OrderArray.Order.TransactionArray.Transaction.Item
  .SellerInventoryID		(Y)-
OrderArray.Order.TransactionArray.Transaction.Item.SKU(Y)-
OrderArray.Order.TransactionArray.Transaction.Item.TitleY-
OrderArray.Order.TransactionArray.Transaction
  .ListingCheckoutRedirectPreference		(Y)-
OrderArray.Order.TransactionArray.Transaction
  .ListingCheckoutRedirectPreference.SellerThirdPartyUsername		(Y)-
OrderArray.Order.TransactionArray.Transaction.QuantityPurchasedY-
OrderArray.Order.TransactionArray.Transaction.RefundArray(Y)-
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund(Y)-
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund
  .RefundFromSeller		(Y)-
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund
  .RefundTime		(Y)-
OrderArray.Order.TransactionArray.Transaction.RefundArray.Refund
  .TotalRefundToBuyer		(Y)-
OrderArray.Order.TransactionArray.Transaction.ShippedTimeY-
OrderArray.Order.TransactionArray.Transaction.Status(Y)-
OrderArray.Order.TransactionArray.Transaction.Status
  .IntegratedMerchantCreditCardEnabled		Y-
OrderArray.Order.TransactionArray.Transaction.Status
  .PaymentHoldStatus		(Y)-
OrderArray.Order.TransactionArray.Transaction.Status
  .PaymentMethodUsed		Y-
OrderArray.Order.TransactionArray.Transaction.TransactionIDY-
OrderArray.Order.TransactionArray.Transaction.TransactionPriceY-
OrdersPerPageY-
PageNumberY-
PaginationResultY-
PaginationResult.TotalNumberOfEntriesY-
PaginationResult.TotalNumberOfPagesY-
ReturnedOrderCountActualY-



Back to top

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

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



Back to top

Input Output Detail Controls Samples Change History Top Errors for GetOrders
GetOrders Change History
Version Description
635
2009-09-16
  • 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.
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.
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.
491
2006-12-13
  • OrderArray.Order.TransactionArray.Transaction.RefundArray (added): Contains information about one or more refunds that have been issued to a buyer. Applicable to Half.com.
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
  • OrderStatus (doc change): Updated the description for the OrderStatus input field to clarify it accepts values of Active or Completed only.
  • OrderArray.Order.CheckoutStatus.PaymentInProcess, OrderArray.Order.CheckoutStatus.PaymentFailure (added): New payment status values have been added for future use.
477
2006-09-06
  • 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.
  • ListingType (modified): Chinese auction listings with Buy It Now are eligible for Express US.
427
2005-09-21
  • TransactionStatus.PaymentMethodUsed (modified): Before this release, if checkout was not yet complete, PaymentMethodUsed was set to None. Now, 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.
415
2005-6-29
  • ShippingDetails.ShippingOptions.ExpeditedService, ShippingTimeMin and ShippingTimeMax (added): Fields for the new Get It Fast feature.
403
2005-4-6
  • ProductPartNumber (added): ProductPartNumber is now returned as part of the SellingManagerProductDetailsType for part numbers that are strings.

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

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