This document explains how to make Order Adjustment API calls. It provides an overview of the formats and parameters you can use with the Order Adjustment API.

Introduction to the Service

Order Adjustment is a SOA service that enables a seller in Germany or Austria to respond appropriately to an over or under payment made by a buyer.

Service Endpoints—The Order Adjustment API has unique gateway URLs (service endpoints) for the Production environment and the Sandbox environment. The service endpoint includes the service version (e.g., v1). When updating to a new major version of the service, you must update to a new service endpoint as well.
HTTP headers and URL parameters—The Order Adjustment API uses eBay's Service Oriented Architecture (SOA) framework and requires that an eBay authorization token is passed in through a (X-EBAY-SOA-SECURITY-TOKEN) header or (SECURITY-TOKEN) URL parameter.
Schema and data type notes—The Order Adjustment API does not share schema or data types with other eBay APIs. In the API, you will find the following differences from other eBay APIs:

No site ID! Instead, we provide globalId, a unique identifier for a combination of site, language, and territory. See the Global ID Values table for a list of global IDs that map to site IDs. The global ID you use must map to an eBay site with a site ID.
XML namespace is versioned. To prevent type collisions associated with backward incompatible service changes, the XML namespace is versioned. As with the service endpoint, when updating to a new major version of the service, note that the XML namespace will change as well.

Naming conventions—The naming conventions for the Order Adjustment API are slightly different than the Trading API. Most notably, call names and fields in the Order Adjustment API begin with lowercase letters.
Versioning scheme—The version numbering scheme for the Order Adjustment API is different from the scheme used by the eBay Shopping and Trading APIs. The Order Adjustment API version consists of three digits (e.g., 1.2.3):

The first digit indicates the major release version. Major releases are not backward compatible. eBay supports the two most recent major versions of the service. The service endpoints and target namespace include the major version of the service.
The second digit indicates the minor release version. Minor releases consist of feature additions or behavior changes that are backward compatible.
The third digit indicates the maintenance, or micro release version. Maintenance releases are used to correct minor problems. Maintenance releases have minimal impact on the features or functionality of the API. These changes may or may not have associated schema changes.

acceptAdjustment Call

This call enables a seller to accept over or under payments from a buyer for a specified order. For more information about the acceptAdjustment call, see the Users Guide.

issueRefund Call

This call enables a seller to voluntarily provide a refund to the buyer. The seller can refund the item price, the shipping cost or an additional amount for specific items, or for the entire order. For more information about the issueRefund call, see the Users Guide.

rejectAdjustment Call

This call enables a seller to reject over or under payments from a buyer for a specified order. For more information about the rejectAdjustment call, see the Users Guide.

getVersion Call

This call returns the current version of the Order Adjustment service. This call has no input parameters.

Supported Request and Response Formats

The Order Adjustment API supports XML and SOAP request and response formats.

XML

The HTTP POST call method supports the use of XML format requests.

<acceptAdjustment xmlns="http://www.ebay.com/marketplace/payment/v1/services">
...
</acceptAdjustment>

SOAP

The HTTP POST call method also supports the use of SOAP format requests. SOAP versions 1.1 and 1.2 are both supported.

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns="http://www.ebay.com/marketplace/payment/v1/services">
   <soap:Header/>
   <soap:Body>
      <acceptAdjustment>
      ...
      </acceptAdjustment>
   </soap:Body>
</soap:Envelope>

The call response for SOAP requests is in SOAP format only.

Call Structure

Each Order Adjustment API call consists of the following elements:

Service Endpoint—Order Adjustment API requests can be sent to either the Production API Gateway (endpoint) or the Sandbox endpoint for the Order Adjustment API.
HTTP Headers or URL Parameters—Each Order Adjustment API call requires a X-EBAY-SOA-SECURITY-TOKEN header or a SECURITY-APPNAME URL parameter. Similarly, you must always specify the call name in the X-EBAY-SOA-OPERATION-NAME header or OPERATION-NAME URL parameter. Other headers are optional or conditionally required.
Standard Input Fields—The ExtensionType field and its four child elements are the only standard input fields for calls in the Order Adjustment API. These fields are optional.
Call-specific Fields—The input fields that are specific to a particular API call.

Service Endpoints

Order Adjustment API requests may be sent to either the eBay Production API Gateway URI (endpoint) or the eBay Sandbox endpoint. You specify the endpoint in the request.

Production Endpoint:

https://svcs.ebay.com/services/opms/v1/OrderAdjustmentService

Sandbox Endpoint:

http://svcs.sandbox.ebay.com/services/opms/v1/OrderAdjustmentService

Note: The service endpoint contains the major version for the service (e.g., v1). When updating to subsequent major releases, you must update the version in the service endpoint, as well.

Standard URL Parameter or HTTP Header Values

When you make a Order Adjustment API call, you choose whether to specify the standard values in URL parameters or in the HTTP header. URL parameters are provided as name-value pairs in the query part of the URI.

Note: If you specify both a URL parameter and an HTTP header for the same value in the same call, the URL parameter takes precedence. The values you provide in your call are case-sensitive.

The following table contains descriptions of the standard Order Adjustment API parameters and the corresponding header values:

URL Parameter Header Value Required? Description

N/A

CONTENT-TYPE

If you use this header, you must specify the content format exactly as shown, or your call may fail. The allowable values are:

XML	text/xml
SOAP12	application/soap+xml
SOAP11	text/xml (together with SOAPAction header being sent - value can be anything)

GLOBAL-ID X-EBAY-SOA-GLOBAL-ID Yes The unique identifier for a combination of site, language, and territory. For example, EBAY-US (the default) is the global ID that corresponds to the eBay US site. The global ID you specify must correspond to an eBay site with a valid site ID. Refer to eBay Site ID to Global ID Mapping. In addition, Global ID Values contains a complete list of the eBay global IDs.

MESSAGE-ENCODING X-EBAY-SOA-MESSAGE-ENCODING Conditionally Specifies the message encoding (e.g., ISO-8859-1). The default encoding is UTF-8. When submitting requests in any format other than UTF-8, you must specify the message encoding.

N/A X-EBAY-SOA-MESSAGE-PROTOCOL Conditionally If you make a SOAP request, you must use this header to specify the protocol you are using. Allowable values are "SOAP11" for SOAP Version 1.1 and "SOAP12" for SOAP Version 1.2.

SERVICE-NAME X-EBAY-SOA-SERVICE-NAME No The name of the service you are using. Specify "OrderAdjustmentService" for all Order Adjustment API calls.

OPERATION-NAME X-EBAY-SOA-OPERATION-NAME Yes The name of the call you are using (for example, acceptAdjustment or issueRefund).

REQUEST-DATA-FORMAT X-EBAY-SOA-REQUEST-DATA-FORMAT No The Order Adjustment API supports XML and SOAP request formats with the HTTP POST method. Input can be in XML or SOAP formats. The default value for HTTP POST requests is XML.
For SOAP requests, you must specify the protocol version in the X-EBAY-SOA-MESSAGE-PROTOCOL header. If you use a URL for an HTTP GET request, REQUEST-DATA-FORMAT is unnecessary because the only valid value is NV (Name-Value Pair).

RESPONSE-DATA-FORMAT X-EBAY-SOA-RESPONSE-DATA-FORMAT No If you use a URL (HTTP GET) request, use this parameter to specify the output format as XML. URL requests do not support SOAP responses. If you use a URL, and you do not specify RESPONSE- DATA-FORMAT, the output format will be XML. If you use the HTTP POST method, the output data (response data) will be in the same format as the input data.

REST-PAYLOAD N/A No If you use a URL, use this parameter to separate the payload part of the URL from the standard headers. Requires no value; anything appearing after this header will be considered part of the call payload. This parameter is ignored in HTTP POST requests.

SECURITY-TOKEN X-EBAY-SOA-SECURITY-TOKEN Yes This header is used to pass in the eBay authorization token, unique to the user's application. You obtain an eBay authorization token by joining the eBay Developers Program.

SERVICE-VERSION X-EBAY-SOA-SERVICE-VERSION No The API version your application supports (e.g., 1.1.0).

URL Parameter Examples

If you are using a URL (and the HTTP GET method), input must be in the NV (Name-Value Pair) format. Use the RESPONSE-DATA-FORMAT header to specify that data is returned in one of the following formats: NV or XML. The following example (wrapped for readability) shows standard Order Adjustment API parameters. RESPONSE-DATA-FORMAT specifies XML for XML output.

https://svcs.ebay.com/services/payment/OrderAdjustmentService/v1?OPERATION-NAME=acceptAdjustment
  &SERVICE-NAME=OrderAdjustmentService
  &SERVICE-VERSION=1.0.0
  &GLOBAL-ID=EBAY-DE
  &SECURITY-TOKEN=<eBayAuthToken>
  &RESPONSE-DATA-FORMAT=XML
  &REST-PAYLOAD
  &Standard input fields
  &Call-specific input fields

HTTP Header Examples

The following example shows standard Order Adjustment API headers for an HTTP POST call using XML:

X-EBAY-SOA-SERVICE-NAME: OrderAdjustmentService
X-EBAY-SOA-OPERATION-NAME: acceptAdjustment
X-EBAY-SOA-SERVICE-VERSION: 1.0.0
X-EBAY-SOA-GLOBAL-ID: EBAY-DE
X-EBAY-SOA-SECURITY-TOKEN: <eBayAuthToken>
X-EBAY-SOA-REQUEST-DATA-FORMAT: XML

The following example shows standard Order Adjustment API headers for an HTTP POST call using SOAP. In the example, the X-EBAY-SOA-REQUEST-DATA-FORMAT header specifies XML. The example also includes X-EBAY-SOA-MESSAGE-PROTOCOL: SOAP12, specifying that you are using SOAP Version 1.2. Without the X-EBAY-SOA-MESSAGE-PROTOCOL header, the service would expect XML input.

X-EBAY-SOA-SERVICE-NAME: OrderAdjustmentService
X-EBAY-SOA-OPERATION-NAME: acceptAdjustment
X-EBAY-SOA-SERVICE-VERSION: 1.0.0
X-EBAY-SOA-GLOBAL-ID: EBAY-DE
X-EBAY-SOA-SECURITY-TOKEN: <eBayAuthToken>
X-EBAY-SOA-REQUEST-DATA-FORMAT: XML
X-EBAY-SOA-MESSAGE-PROTOCOL: SOAP12

Call-Specific Values

Refer to the Order Adjustment API Call Reference for the input and output fields supported by the Order Adjustment API calls.

Syntax

This section spells out the syntax requirements for the supported request and response formats. In most cases, the syntax for the various formats is standard and only the rules that aren't standard or are potentially tricky are explained.

XML Syntax
SOAP Syntax

UTF-8 Encoding for Special Characters

All parameter values should be encoded in UTF-8 format. UTF-8 is the default encoding for API requests.

Once the parameter value is UTF-8 encoded, it should be URL-encoded to take care of spaces and quotation marks (" ") and other characters in the string that are pertinent to the URL request.

When submitting requests in any format other than UTF-8, you must specify the message encoding with the MESSAGE-ENCODING URL parameter or the X-EBAY-SOA-MESSAGE-ENCODING HTTP header.

URL Encoding for String Values

Name-value requests must be constructed using the ASCII character-set only. Most ASCII characters (e.g., the numbers from 0-9 and the uppercase and lowercase English letters from A to Z) can be used as is. Some special characters, however, such as spaces, ampersands ("&") and quotation marks, must be encoded in URL requests when used in string values for fields.

Special characters that must be URL-encoded include (but are not limited to) characters used in URL request syntax, such as ampersands ("&"), the equals sign ("="), the pound sign ("#"), the "at" symbol ("@"), or the percent sign ("%").

URL-encoded characters are in the form %HH, where HH is a hexadecimal number. For example, the URL-encoded value for an ampersand is %26 and the URL-encoded value for a space is %20. The plus sign ("+") can also be used in place of spaces.

Many languages provide functions or methods to do the URL encoding for you. For example, PHP provides the rawurlencode function and Java provides URLEncoder class. For more information about URL encoding, see RFC 1738.

XML Syntax

The XML request/response format follows standard XML syntax conventions. Please see XML Syntax Rules on w3schools.com for more information.

SOAP Syntax

The SOAP request/response format follows standard SOAP syntax conventions. Please see SOAP Syntax on w3schools.com for more information.

Testing Overview

You can use the Sandbox environment (with the http://svcs.sandbox.ebay.com/services/opms/v1/OrderAdjustmentService endpoint) to test calls to the Order Adjustment API. The Order Adjustment API will be 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.

For more information, see the Sandbox section of the New eBay Payment Process for eBay.de and eBay.at Sites page.

Schema Location

You can download the latest version of the WSDL for the Order Adjustment API with the following link:

http://developer.ebay.com/webservices/order-adjustment/latest/OrderAdjustmentService.wsdl

Alternatively, you can access a particular version of the Order Adjustment schema using a URL with the following format (where VERSION is the version identifier of the release):

http://developer.ebay.com/webservices/order-adjustment/VERSION/OrderAdjustmentService.wsdl

The version identifier is the version number of a particular schema (a release number).

For example, you can access version 1.0.0 of the WSDL version of the schema at the following URL:

http://developer.ebay.com/webservices/order-adjustment/1.0.0/OrderAdjustmentService.wsdl

User-Contributed Notes

Order Adjustment API Making an API Call