This document contains basic information about the construction of calls. For more information, see the Users Guide.
For each of the APIs, the information is divided into the following sections:
This service, formerly for billing calls, is being replaced by the Open eBay Subscription service.
The Open eBay Application Integration Service supports a subset of call formats supported by the eBay SOA framework.
The Open eBay Application Integration Service supports HTTP POST requests and responses in SOAP and XML format only.
Open eBay Application Integration Service supports the following HTTP headers.
| Header Value | Required? | Description | ||||
|---|---|---|---|---|---|---|
| CONTENT-TYPE | No | If you use this header, you must specify the content format exactly as shown, or your call may fail. The allowable values are:
| ||||
| X-EBAY-SOA-MESSAGE-PROTOCOL | Conditionally | Only required for SOAP requests. Use this header to specify the protocol you are using. The only value allowed is "SOAP12" for SOAP version 1.2. | ||||
| X-EBAY-SOA-OPERATION-NAME | Yes | The name of the call you are using. | ||||
| X-EBAY-EIDP-IDENTITY | Yes | Your eBay Developers Program AppID. | ||||
| X-EBAY-EIDP-TOKEN | Yes | Your Open eBay Identity Provider token. Obtain this value with the login call. |
All requests must be sent to either the eBay Sandbox or Production gateway. You specify the gateway URL in the request.
Sandbox Gateway URL (endpoint):
https://svcs.sandbox.ebay.com/OpeneBayApplicationIntegrationService
Production Gateway URL (endpoint):
https://svcs.ebay.com/OpeneBayApplicationIntegrationService
The latest WSDL is at the following location:
Alternatively, you can retrieve a particular version of the WSDL using a URL with the following format, where VERSION is the version identifier of the release:
http://developer.ebay.com/webservices/open-ebay-application-integration/VERSION/OpeneBayApplicationIntegrationService.wsdl
For example, if you were trying to access version 1.0.0 of a WSDL, you would use:
The Open eBay Identity Provider Service supports a subset of call formats supported by the eBay SOA framework.
The Open eBay Identity Provider Service supports SOAP and XML calls only.
The Open eBay Identity Provider Service supports the following HTTP headers.
| Header Value | Required? | Description | ||||
|---|---|---|---|---|---|---|
| CONTENT-TYPE | No | If you use this header, you must specify the content format exactly as shown, or your call may fail. The allowable values are:
| ||||
| X-EBAY-SOA-MESSAGE-PROTOCOL | Conditionally | Only required for SOAP requests. Use this header to specify the protocol you are using. The only value allowed is "SOAP12" for SOAP version 1.2. | ||||
| X-EBAY-SOA-OPERATION-NAME | Yes | The name of the call you are using. | ||||
| X-EBAY-EIDP-IDENTITY | Yes | Your eBay Developers Program AppID. Not used with the login call. | ||||
| X-EBAY-EIDP-TOKEN | Yes | Your Open eBay Identity Provider token. Obtain this value with the login call. This header is not used with the login call. |
All requests must be sent to either the eBay Sandbox or Production gateway. You specify the gateway URL in the request.
Sandbox Gateway URL (endpoint):
https://svcs.sandbox.ebay.com/OpeneBayIdentityProviderService
Production Gateway URL (endpoint):
https://svcs.ebay.com/OpeneBayIdentityProviderService
The latest WSDL is at the following location:
Alternatively, you can retrieve a particular version of the WSDL using a URL with the following format, where VERSION is the version identifier of the release:
http://developer.ebay.com/webservices/open-ebay-identity-provider/VERSION/OpeneBayIdentityProviderService.wsdl
For example, if you were trying to access version 1.0.0 of a WSDL, you would use:
You must use an OpeneBayParticipantInterface listener to receive requests for adding and removing application subscribers.
eBay makes calls to your OpeneBayParticipantInterface listener.
For more information about the OpeneBayParticipantInterface listener, see the Users Guide.
For the OpeneBayParticipantInterface service, only the XML format is supported. It is suggested that you manually change OpeneBayParticipantInterfaceService.wsdl to an XSD file.
When eBay sends calls,
eBay includes a cmd parameter in the URL. Your application should check the value
of this cmd parameter in the URL, because the value is the name of the call. For
example, eBay might use the following URL:
https://SampleCompany.com/Listener/IntegrationManagement?cmd=addSubscriber
When eBay sends addSubscriber and removeSubscriber calls, eBay includes the following HTTP Headers (and the others should be ignored):
In your deployment descriptor, find the Link field
whose rel attribute is EndPoint.Management.
Set its href to the URL for your implementation of OpeneBayParticipantInterface.
For information about the deployment
descriptor, see the Users Guide.
The latest WSDL is at the following location:
Alternatively, you can retrieve a particular version of the WSDL using a URL with the following format, where VERSION is the version identifier of the release:
http://developer.ebay.com/webservices/open-ebay-participant-interface/VERSION/OpeneBayParticipantInterfaceService.wsdl
For example, if you were trying to access version 1.0.0 of a WSDL, you would use:
A service for calls that you make related to subscribers and billing.
The Open eBay Subscription service supports a subset of call formats supported by the eBay SOA framework.
The Open eBay Subscription service supports HTTP POST requests and responses in SOAP and XML format only.
Open eBay Subscription service supports the following HTTP headers.
| Header Value | Required? | Description | ||||
|---|---|---|---|---|---|---|
| CONTENT-TYPE | No | If you use this header, you must specify the content format exactly as shown, or your call may fail. The allowable values are:
| ||||
| X-EBAY-SOA-MESSAGE-PROTOCOL | Conditionally | Only required for SOAP requests. Use this header to specify the protocol you are using. The only value allowed is "SOAP12" for SOAP version 1.2. | ||||
| X-EBAY-SOA-OPERATION-NAME | Yes | The name of the call you are using. | ||||
| X-EBAY-EIDP-IDENTITY | Yes | Your eBay Developers Program AppID. | ||||
| X-EBAY-EIDP-TOKEN | Yes | Your Open eBay Identity Provider token. Obtain this value with the login call. |
All requests must be sent to either the eBay Sandbox or Production gateway. You specify the gateway URL in the request.
Sandbox Gateway URL (endpoint):
https://svcs.sandbox.ebay.com/services/openebay/v1/OpeneBaySubscriptionService
Production Gateway URL (endpoint):
https://svcs.ebay.com/services/openebay/v1/OpeneBaySubscriptionService
The latest WSDL is at the following location:
http://developer.ebay.com/webservices/open-ebay-subscription/latest/OpeneBaySubscriptionService.wsdl
Alternatively, you can retrieve a particular version of the WSDL using a URL with the following format, where VERSION is the version identifier of the release:
http://developer.ebay.com/webservices/open-ebay-subscription/VERSION/OpeneBaySubscriptionService.wsdl
For example, if you were trying to access version 1.0.0 of a WSDL, you would use:
http://developer.ebay.com/webservices/open-ebay-subscription/1.0.0/OpeneBaySubscriptionService.wsdl
© 2008–2010 eBay Inc. All rights reserved.
eBay and the eBay logo are registered trademarks of eBay Inc.
All other brands are the property of their respective owners.
