acceptAdjustment

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 acceptAdjustment call to accept over or under payments from a buyer for a specified order. It has one input parameter, orderId.id, and the response contains only the standard output fields.

Currently, acceptAdjustment may be applied to one order at a time.

Request Details

To accept an over or under payment by a buyer on a particular order, use the acceptAdjustment call. A valid eBay order ID is required to be passed into the orderId.id field. With this call, the seller indicates that the payment on the order is satisfactory.

Working with the Response

The acceptAdjustment response contains only the standard output fields. If the call is successful, a payment adjustment is created on the order.

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

acceptAdjustment 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"?>
<acceptAdjustmentResponse 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>
</acceptAdjustmentResponse>

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.

acceptAdjustment 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

Enables a seller to accept over or under payments from a buyer for a specified order.

Description

This acceptAdjustment call enables a seller to accept over or under payments from a buyer for a specified order. If the call is successful, a payment adjustment is created on the order.

This call will fail if an invalid order ID is passed in. The caller must be authenticated to make this call.

Input

A seller wants to accept the adjusted order amount paid by a buyer for a specific order ID. The order ID is 2222222.

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

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

Output

The ack field indicates whether the 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 and SOAP_XML equivalents.

<?xml version="1.0" encoding="UTF-8"?>
<acceptAdjustmentResponse xmlns="http://www.ebay.com/marketplace/payment/v1/services">
   <ack>Success</ack>
   <version>1.0.0</version>
   <timestamp>2012-04-05T23:01:09.352Z</timestamp>
</acceptAdjustmentResponse>

acceptAdjustment Change History

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

User-Contributed Notes

orderId	OrderIdType	Required	Contains information identifying the eBay order for which the refund will be issued.
orderId.id	string	Required	A unique identifier of an eBay order. This field will accept an eBay OrderID value (generated by eBay for multiple line item orders) or an OrderLineItemID value, which is a concatenation of ItemID and TransactionID with a hyphen separating these two IDs. For more information about eBay orders, see the Trading API documentation.

Order Adjustment API Call Reference Version 1.0.0