getVersion

Note: The Order Adjustment API is available for testing with simulated responses in the Sandbox on April 7, 2012. The API will be available with full functionality in the Sandbox on May 7, 2012.

Use the getVersion call to retrieve the current version number of the Order Adjustment service. This call can be used to monitor the service for availability. It has no input parameters and the response contains only the standard output fields.

getVersion Input

getVersion has no input fields.

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

<?xml version="1.0" encoding="utf-8"?>
<getVersionResponse xmlns="http://www.ebay.com/marketplace/payment/v1/services">
  <!-- Standard Output Fields -->
  <ack> AckValue </ack>
  <errorMessage> ErrorMessage
    <error> ErrorData
      <errorId> long </errorId>
      <message> string </message>
    </error>
    <!-- ... more error nodes here ... -->
  </errorMessage>
  <extension> ExtensionType
    <contentType> string </contentType>
    <id> positiveInteger </id>
    <value> string </value>
    <version> string </version>
  </extension>
  <!-- ... more extension nodes here ... -->
  <timestamp> dateTime </timestamp>
  <version> string </version>
</getVersionResponse>

Return Value	Type	Occurrence	Meaning

Standard Output Fields

ack	AckValue	Always	A token representing the application-level acknowledgement code that indicates the response status (e.g., Success). The AckValue list specifies the possible values for Ack. Applicable values: • Failure (out) The request was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data. • PartialFailure (out) The request was processed successfully, but something occurred that might affect your application or the user. See errorMessage.error to determine which portions of the request failed. • Success (out) The request was processed successfully. • Warning (out) The request was processed successfully but with some warnings. See errorMessage.error to determine the nature of the warning.
errorMessage	ErrorMessage	Conditionally	Contains information for warnings or errors that occurred when eBay processed the request. Note: This field is not returned if the value of ack is Success.
errorMessage.error	ErrorData	Conditionally, repeatable: [0..*]	A container for the warning or error details.
errorMessage.error.errorId	long	Conditionally	A unique code that identifies the particular warning or error condition that occurred. Your application can use error codes as identifiers in your customized error- handling algorithms.
errorMessage.error.message	string	Conditionally	A description of the warning or error condition that occurred.
extension	ExtensionType	Conditionally, repeatable: [0..*]	This container is reserved for internal or future use.
extension.contentType	string	Conditionally	Reserved for internal or future use.
extension.id	positiveInteger	Conditionally	Reserved for internal or future use.
extension.value	string	Conditionally	Reserved for internal or future use.
extension.version	string	Conditionally	Reserved for internal or future use.
timestamp	dateTime	Always	The date and time that the response was returned.
version	string	Always	The current version number of the Order Adjustment service.

getVersion Samples

New to making API calls? Please see Making an API Call.

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

Sample: Basic

Retrieves the current service version for Order Adjustment.

Description

This call has no input parameters. Specify the call name and AppID in the HTTP headers or URL parameters. You can use this call to test your headers and to ensure the service is up and running.

Input

There are no input parameters.

XML format (HTTP POST). Also available are the .txt version of this XML and the SOAP equivalent.

<?xml version="1.0" encoding="utf-8"?>
<getVersionRequest xmlns="http://www.ebay.com/marketplace/payment/v1/services">
</getVersionRequest>

Output

The ack field indicates whether your call was successful or not. The version field indicates the current version of the service.

XML format. Also available are the .txt version of this XML and the SOAP equivalent.

<?xml version="1.0" encoding="UTF-8"?>
<getVersionResponse xmlns="http://www.ebay.com/marketplace/payment/v1/services">
   <ack>Success</ack>
   <version>1.0.0</version>
   <timestamp>2012-05-12T00:00:00.333Z</timestamp>
</getVersionResponse>

getVersion Change History

Version	Description
1.0.0 2012-April-07	(added) New call.

User-Contributed Notes