GetOrders - Call Reference - eBay Trading Web Services

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 can be used 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 one set of filtering arguments is used, the arguments for the other set 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. This call can also be used to retrieve unshipped Half.com orders (i.e., orders that the seller has received but has not yet processed).

See Working with Combined Payment.

Related calls:

AddOrder - Combines two or more transactions into a single order, enabling a buyer to pay for all of those transactions with a single payment (and, if so arranged, ship all of the items together).
GetOrderTransactions - Retrieves information about one or more orders or one or more transactions (or both).

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 may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).

<?xml version="1.0" encoding="utf-8"?>
<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	Reqd?	Meaning
Standard Input Fields [Jump to call-specific fields]
DetailLevel	DetailLevelCodeType (repeatable)	Optional	Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. For example, a particular detail level might cause the response to include buyer-related data in every result (e.g., for every Item), but no seller-related data. Specifying a detail level is like using a predefined attribute list in the SELECT clause of an SQL query. Use the DetailLevel element to specify the required detail level that the client application needs pertaining to the data components that are applicable to the request. The DetailLevelCodeType defines the global list of available detail levels for all request types. Most request types support certain detail levels or none at all. If you pass a detail level that exists in the schema but that isn't valid for a particular request, eBay ignores it processes the request without it. For each request type, see the detail level tables in the Input/Output Reference to determine which detail levels are applicable and which elements are returned for each applicable detail level. (Some detail level tables are still in the eBay Web Services guide. They will be moved to the Input/Output Reference in a future release.) Note that DetailLevel is required input for GetMyMessages. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you do use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. Applicable values: • ReturnAll (in) Returns all available data. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. (Not all values in DetailLevelCodeType apply to this field.)
ErrorLanguage	string	Optional	Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong See Tags for the Identification of Languages.
MessageID	string	Optional	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
OutputSelector	string (repeatable)	Optional	You can use the OutputSelector field to restrict the data returned by this call. When you make a call such as GetItem that retrieves data from eBay, the OutputSelector field is useful for restricting the data returned. This field makes the call response easier to use, especially when a large payload would be returned. If you use the OutputSelector field, the output data will include only the fields you specified in the request. For example, if you are using GetItem and you want the item data in the response to be restricted to the ViewItemURL (the URL where a user can view the listing) and BuyItNowPrice, then within the GetItem request, specify those output fields. To use this field, see the information at the following link. See Selecting Fields to Retrieve.
Version	string	Conditional	The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects: - It indicates the version of the code lists and other data that eBay should use to process your request. - It indicates the schema version you are using. You need to use a version that is greater than or equal to the lowest supported version. For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See: HTTP Headers (XML API Only) eBay Schema Versioning Strategy Lowest Supported Version
WarningLevel	WarningLevelCodeType	Optional	Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level.
Call-specific Input Fields
CreateTimeFrom	dateTime	Conditional	The starting date of the date range for the orders to retrieve. Also applicable to Half.com.
CreateTimeTo	dateTime	Conditional	The ending date of the date range for the orders to retrieve. Also applicable to Half.com.
ListingType	ListingTypeCodeType	Conditional	To retrieve Half.com orders, specify Half. To retrieve eBay orders, don't specify this field at all. (This field can't 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) Half.com listing (item is listed on Half.com, not on eBay). You must be a registered Half.com seller to use this format. Starting in April 2007, some Half.com items might also be included on eBay Express US. (Not all values in ListingTypeCodeType apply to this field.)
OrderIDArray	OrderIDArrayType	Conditional	A set of orders to retrieve. Does not retrieve Express orders, even when the explicit Express OrderID found on the eBay Express site is included in the request. Not applicable to Half.com.
OrderIDArray.OrderID	OrderIDType (string) (repeatable)	Conditional	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: 0. Max: 2147483647. Default: 0.

GetOrders Output

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

See also Samples.

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

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

<?xml version="1.0" encoding="utf-8"?>
<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>
        <LastModifiedTime> dateTime </LastModifiedTime>
        <PaymentMethod> BuyerPaymentMethodCodeType </PaymentMethod>
        <Status> CompleteStatusCodeType </Status>
      </CheckoutStatus>
      <CreatedTime> dateTime </CreatedTime>
      <CreatingUserRole> TradingRoleCodeType </CreatingUserRole>
      <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>
            <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 
            <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	Returned?	Meaning
Standard Output Fields [Jump to call-specific fields]
Ack	AckCodeType	Always	A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack. Applicable values: • CustomCode (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.)
Build	string	Always	This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID	string	Conditionally	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors	ErrorType (repeatable)	Conditionally	A list of application-level errors (if any) that occurred when eBay processed the request. See Error Handling.
Errors.ErrorClassification	ErrorClassificationCodeType	Conditionally	API errors are divided between two classes: system errors and request errors. Applicable values: • CustomCode (out) Reserved for internal or future use. • RequestError (out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. • SystemError (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
Errors.ErrorCode	token	Conditionally	A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
Errors.ErrorParameters	ErrorParameterType (repeatable)	Conditionally	This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters [ attribute ParamID ]	string	Conditionally	The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value	string	Conditionally	The value of the variable (e.g., the attribute set ID)
Errors.LongMessage	string	Conditionally	A more detailed description of the condition that raised the error.
Errors.SeverityCode	SeverityCodeType	Conditionally	Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user. Applicable values: • CustomCode (out) Reserved for internal or future use • Error (out) Application-level error • Warning (out) Warning or informational error
Errors.ShortMessage	string	Conditionally	A brief description of the condition that raised the error.
HardExpirationWarning	string	Conditionally	Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp	dateTime	Always	This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version	string	Always	The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.
Call-specific Output Fields
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). DetailLevel: Returned if DetailLevel is not provided on input.
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). DetailLevel: Returned if DetailLevel is not provided on input.
OrderArray.Order	OrderType (repeatable)	Always	Also applicable to Half.com. DetailLevel: Returned if DetailLevel is not provided on input. See Working with Combined Payment.
OrderArray.Order .AdjustmentAmount	AmountType (double)	Always	Amount by which the buyer is adjusting the order total. Used when the seller has not supplied payment details such as shipping and handling or insurance fee. Also applicable to Half.com (for GetOrders). DetailLevel: Returned if DetailLevel is not provided on input.
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. DetailLevel: Returned if DetailLevel is not provided on input.
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. DetailLevel: Returned if DetailLevel is not provided on input.
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. DetailLevel: Returned if DetailLevel is not provided on input.
OrderArray.Order .CheckoutStatus	CheckoutStatusType	Always	The current checkout status of the order. Also applicable to Half.com (for GetOrders). DetailLevel: Returned if DetailLevel is not provided on input.
OrderArray.Order .CheckoutStatus .eBayPaymentStatus	PaymentStatusCodeType	Always	Indicates the success or failure of a buyer's online payment. Also applicable to Half.com (for GetOrders). Applicable values: • BuyerCreditCardFailed (out) The buyer's credit card failed. • BuyerECheckBounced (out) The buyer's eCheck bounced. • BuyerFailedPaymentReportedBySeller (out) The seller reports that the buyer's payment failed. • CustomCode (out) Reserved for internal or future use. • NoPaymentFailure (out) No payment failure. • PaymentInProcess (out) Currently for eBay Germany only. • PayPalPaymentInProcess (out) The payment from buyer to seller is in PayPal process, but has not yet been completed. DetailLevel: Returned if DetailLevel is not provided on input.
OrderArray.Order .CheckoutStatus .LastModifiedTime	dateTime	Always	The time the status was last modified. Also applicable to Half.com (for GetOrders). DetailLevel: Returned if DetailLevel is not provided on input.
OrderArray.Order .CheckoutStatus.PaymentMethod	BuyerPaymentMethodCodeType	Always	The payment method the buyer uses to purchase the item. Also applicable to Half.com (for GetOrders). Applicable values: See PaymentMethod. DetailLevel: Returned if DetailLevel is not provided on input.
OrderArray.Order .CheckoutStatus.Status	CompleteStatusCodeType	Always	The status of the order. Also applicable to Half.com (for GetOrders). Applicable values: • Complete (in/out) Transaction is complete. • CustomCode (in/out) Reserved for internal or future use • Incomplete (in/out) Transaction is incomplete. • Pending (in/out) Transaction is pending. DetailLevel: Returned if DetailLevel is not provided on input.
OrderArray.Order.CreatedTime	dateTime	Always	Date and time the order was created. Also applicable to Half.com (for GetOrders). DetailLevel: Returned if DetailLevel is not provided on input.
OrderArray.Order .CreatingUserRole	TradingRoleCodeType	Always	Indicates whether the order is created by the buyer or by the seller. Applicable values: • Buyer (in/out) Acting as buyer. • CustomCode (in/out) Reserved for future use. • Seller (in/out) Acting as seller. For GetOrders, you can use this value to limit orders to those where the calling user is the seller. DetailLevel: Returned if DetailLevel is not provided on input.
OrderArray.Order.OrderID	OrderIDType (string)	Always	Unique identifier that eBay generates for the order. For calls like GetItemTransactions (and the Checkout notification), no OrderID will appear when only 1 item is purchased in a single end-to-end checkout flow (because the transaction would not be part of an order in this case). Also applicable to Half.com (for GetOrders). DetailLevel: Returned if DetailLevel is not provided on input.
OrderArray.Order.OrderStatus	OrderStatusCodeType	Always	The current status of the order. For transaction calls (like GetItemTransactions), please use the TransactionPlatform element to determine whether an item was purchased on Express on eBay. Also applicable to Half.com (for GetOrders). Applicable values: • Active (in/out) The cart is active. Items can only be added, deleted, or updated in the cart when status is Active. • Authenticated (out) The cart was authenticated. • Cancelled (out) The cart was cancelled. • Completed (in/out) The order is completed. • CustomCode (out) Reserved for internal or future use. • Default (out) Default status. • Inactive (out) The cart is invalid; it does not exist. An example is a cart that has expired. • InProcess (out) After placing the order and before completion of checkout, the card is "in process." • Invalid (out) Invalid. • Shipped (in/out) The order was shipped. Half.com users can specify this in the GetOrders input. DetailLevel: Returned if DetailLevel is not provided on input.
OrderArray.Order.PaidTime	dateTime	Conditionally	Date and time the order was paid. This time is specified in GMT (not Pacific time). See "Time Values" in the eBay Web Services guide for information about converting between GMT and other time zones. Also applicable to Half.com (for GetOrders). DetailLevel: Returned if DetailLevel is not provided on input.
OrderArray.Order .PaymentMethods	BuyerPaymentMethodCodeType (repeatable)	Always	The payment methods the buyer uses to pay for the order. An order can have multiple payment methods if the buyer combines several transactions into one order. Also applicable to Half.com (for GetOrders). Applicable values: See PaymentMethods. DetailLevel: Returned if DetailLevel is not provided on input.
OrderArray.Order.ShippedTime	dateTime	Conditionally	Date and time the order was shipped. This time is specified in GMT (not Pacific time). See "Time Values" in the eBay Web Services guide for information about converting between GMT and other time zones. Also applicable to Half.com (for GetOrders). DetailLevel: Returned if DetailLevel is not provided on input.
OrderArray.Order .ShippingAddress	AddressType	Always	Shipping address the order has been or will be sent to. Also applicable to Half.com (for GetOrders). DetailLevel: Returned if DetailLevel is not provided on input.
OrderArray.Order .ShippingAddress.AddressID	string	Always	ID assigned to the address in the eBay database. For GetOrders, applies only to Half.com. DetailLevel: Returned if DetailLevel is not provided on input.
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. DetailLevel: Returned if DetailLevel is not provided on input.
OrderArray.Order .ShippingAddress.CityName	string	Always	The name of the user's city. Also applicable to Half.com (for GetOrders). Max length: 64. DetailLevel: Returned if DetailLevel is not provided on input.
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. DetailLevel: Returned if DetailLevel is not provided on input.
OrderArray.Order .ShippingAddress.CountryName	string	Always	The name of the user's country. Also applicable to Half.com (for GetOrders). DetailLevel: Returned if DetailLevel is not provided on input.
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. DetailLevel: Returned if DetailLevel is not provided on input.
OrderArray.Order .ShippingAddress.Name	string	Always	User's name for the address. Also applicable to Half.com (for GetOrders). Max length: 64. DetailLevel: Returned if DetailLevel is not provided on input.
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). DetailLevel: Returned if DetailLevel is not provided on input.
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. DetailLevel: Returned if DetailLevel is not provided on input.
OrderArray.Order .ShippingAddress .StateOrProvince	string	Always	The region of the user's address. Also applicable to Half.com (for GetOrders). Max length: 64. DetailLevel: Returned if DetailLevel is not provided on input.
OrderArray.Order .ShippingAddress.Street1	string	Always	Line 1 of the user's street address. Also applicable to Half.com (for GetOrders). Max length: 100. DetailLevel: Returned if DetailLevel is not provided on input.
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. DetailLevel: Returned if DetailLevel is not provided on input.
OrderArray.Order .ShippingDetails	ShippingDetailsType	Always	The shipping-related details for an item or transaction, including flat or calculated shipping costs and shipping insurance costs. Also applicable to Half.com (for GetOrders). DetailLevel: Returned if DetailLevel is not provided on input.
OrderArray.Order .ShippingDetails.CODCost	AmountType (double)	Conditionally	Italy site (site ID 101) only. Contains the cash-on-delivery (COD) cost, for COD shipping. DetailLevel: Returned if DetailLevel is not provided on input. 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. Also applicable to Half.com (for GetOrders). DetailLevel: Returned if DetailLevel is not provided on input.
OrderArray.Order .ShippingDetails.InsuranceFee	AmountType (double)	Always	Cost of shipping insurance set by the seller. If the buyer bought more than one of this item, this is the insurance for just a single item. Exception: for GetItemShipping, this is proportional to QuantitySold. Value should be greater than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. Optional as input and only allowed if ChangePaymentInstructions is true. This field is ignored when InsuranceOption is not specified in the request. This field is ignored when Item.ListingType=Express. Applicable to Half.com for GetOrders. Not applicable to eBay Motors vehicle listings. Default: 0.00. DetailLevel: Returned if DetailLevel is not provided on input.
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. Flat and calculated shipping. Optional as input and only allowed if ChangePaymentInstructions is true. Also applicable to Half.com (for GetOrders). This field is ignored when Item.ListingType=Express. If this field is not included in the request, values specified in the InsuranceFee field will be ignored. Applicable values: • CustomCode (in/out) Reserved for internal or future use • IncludedInShippingHandling (in/out) The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost. • NotOffered (in/out) The seller does not offer shipping insurance to the buyer. • NotOfferedOnSite (out) Shipping insurance is not offered as a separate option on the site where the item is listed. (Some shipping services, such as DE_InsuredExpressOrCourier, include insurance as part of the service.) If another insurance option is specified in the listing request and the site does not support shipping insurance as a separate option, eBay will reset the insurance option to this value. At the time of this writing, this option is only meaningful for the eBay Germany, Austria, and Switzerland sites. • Optional (in/out) The seller offers the buyer the choice of paying for shipping insurance or not. • Required (in/out) The seller requires that the buyer pay for shipping insurance. DetailLevel: Returned if DetailLevel is not provided on input.
OrderArray.Order .ShippingDetails .InsuranceWanted	boolean	Always	Whether the buyer selected to pay for insurance offered by the seller as an option. This only has a value after the buyer has gone through checkout and selected the insurance preference. Also applicable to Half.com (for GetOrders). DetailLevel: Returned if DetailLevel is not provided on input.
OrderArray.Order .ShippingDetails .InternationalShippingServiceOption	InternationalShippingServiceOptionsType (repeatable)	Conditionally	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. Not applicable to Half.com or eBay Motors vehicle listings. This field is ignored when Item.ListingType=Express. DetailLevel: Returned if DetailLevel is not provided on input. See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1).
OrderArray.Order .ShippingDetails .InternationalShippingServiceOption .ShippingInsuranceCost	AmountType (double)	Conditionally	The insurance cost associated with shipping a single item with this shipping service. Exception: for GetItemShipping, this is proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only. Also applicable to Half.com (for GetOrders). DetailLevel: Returned if DetailLevel is not provided on input. See Shipping.
OrderArray.Order .ShippingDetails .InternationalShippingServiceOption .ShippingInsuranceCost [ attribute currencyID ]	CurrencyCodeType	Conditionally	Currency in whi

eBay Trading API Call Reference Version 579

eBay Trading API
Call Reference Version 579