Open eBay Participant Interface
|
You can find links to Open eBay Apps documentation in the top navigation bar. Information about the schema location is in the Schema Location section of the "Making an API Call" topic.
Are you new to Open eBay Apps?
If so, see Open eBay Apps User Guide -- an introduction to Open eBay Apps.
Are you just getting started with the eBay Developers Program?
Please see:
| Version | Release Date | |
|---|---|---|
| 1.5.0 | 2010-10-13 | |
| 1.4.0 | 2010-03-03 | |
| 1.3.0 | 2009-09-30 | |
| 1.2.0 | 2009-06-24 | |
| 1.1.0 | 2009-04-01 |
For a current list of known issues, see System Announcements and the Knowledge Base.
Index of Changed Calls - 1.5.0
No changed calls in this release.
| Name | Part of Schema | Type of Change | OpeneBayUpdateSubscriberPaymentMethodRequestType |
Complex type | New |
|---|---|---|
OpeneBayUpdateSubscriberPaymentMethodResponseType |
Complex type | New |
eBay sends an updateSubscriberPaymentMethod request to your application
when a subscriber's payment method has changed.
A payment method is either manual or automatic.
If the payment method is manual, the subscriber doesn't have a recurring
payment method set up. If the payment method is automatic, the subscriber has a recurring
payment method set up (currently, only PayPal is available).
For more information, see updateSubscriberPaymentMethod.
For a current list of known issues, see System Announcements and the Knowledge Base.
Index of Changed Calls - 1.4.0
| Name | Part of Schema | Type of Change |
|---|---|---|
OpeneBayChangeSubscriptionPlan |
Complex type | New call |
OpeneBayUpdateSubscriberCredentials |
Complex type | New call |
OpeneBaySubscriptionReasonCode |
Enumerated type | New |
OpeneBaySubscriptionInfoType.billStartDate |
Element | New |
OpeneBaySubscriptionInfoType.cancelDate |
Element | New |
OpeneBaySubscriptionInfoType.endDate |
Element | New |
OpeneBaySubscriptionInfoType.startDate |
Element | New |
OpeneBaySubscriptionInfoType.subscriptionState |
Element | New |
OpeneBaySubscriptionStateChangeInfoType.reasonCode |
Element | New |
OpeneBaySubscriptionStateType.Expired |
Enum | New |
A third party developer can enable subscribers to change from one subscription plan to another without formally unsubscribing to the original plan. This functionality is available for an application in the sandbox or in production only if the third party developer requests this functionality from eBay. The third party developer can request this functionality for production only after initial testing in the sandbox.
If the option is enabled, then when the user changes their plan (on the Applications tab in My eBay), eBay makes a changeSubscriptionPlan call to the third party application.
The changeSubscriptionPlan request contains the new external plan ID, subscription ID, and related values. For more information, see the changeSubscriptionPlan call.
The requests of several calls in the OpeneBayParticipantInterface now contain more information, e.g. the billing start date. See the table above for the new elements. The OpeneBayParticipantInterface Call Reference describes which fields are in each call.
An updateSubscriberCredentials call will be sent by eBay to notify your application that a user's Auth token was renewed or revoked.
If your application doesn't respond to an addSubscriber call after eBay has sent 6 retries (across a day), then after 24 hours, the retries are stopped and the subscription is put in a cancelled state.
For a current list of known issues, see System Announcements and the Knowledge Base.
Index of Changed Calls - 1.3.0
Documentation Changes and Errata - 1.3.0
| Name | Part of Schema | Type of Change |
|---|---|---|
OpeneBaySubscriptionStateChangeInfoType |
Complex type | New |
OpeneBayUpdateSubscriberRequestType |
Complex type | New |
OpeneBayUpdateSubscriberResponseType |
Complex type | New |
OpeneBaySubscriptionStateType |
Enumerated type | New |
The updateSubscriber call is sent by eBay when you need to update information about an eBay member in your subscription database.
You can use the developer tools announcements page to view the latest status for SM Apps tools.
The documentation additions include updates to:
For a current list of known issues, see System Announcements and the Knowledge Base.
Index of Changed Calls - 1.2.0
Documentation Changes and Errata - 1.2.0
The changed calls will be changed in late June, 2009.
No new calls in this release.
| Name | Part of Schema | Type of Change |
|---|---|---|
BaseAuthenticateRequestType |
Complex type | Removed |
BaseRequestHeaderType |
Complex type | Removed |
BaseServiceResponse |
Complex type | Removed |
ErrorData |
Complex type | Removed |
ErrorMessage |
Complex type | Removed |
ErrorParameter |
Complex type | Removed |
OpeneBayAuthenticatedRequestCredentialsType |
Complex type | Removed |
OpeneBayAuthenticatedRequestHeaderType |
Complex type | Removed |
OpeneBayBaseNVType |
Complex type | Removed |
OpeneBayLoginCredentialsType |
Complex type | Removed |
OpeneBaySecurityTokenReferenceType |
Complex type | Removed |
OpeneBaySecurityTokenValueType |
Complex type | Removed |
OpeneBaySubscriptionDataType |
Complex type | Removed |
OpeneBaySubscriptionStatusMessageType |
Complex type | Removed |
OpeneBayUnauthenticatedRequestHeaderType |
Complex type | Removed |
AckValue |
Enumerated type | Removed |
ErrorCategory |
Enumerated type | Removed |
ErrorSeverity |
Enumerated type | Removed |
OpeneBayApplicationOperationalStateType |
Enumerated type | Removed |
OpeneBayEventType |
Enumerated type | Removed |
OpeneBayAddSubscriberRequestType.subscriberInfo |
Element | Removed |
OpeneBayAddSubscriberRequestType.subscriptionData |
Element | Removed |
OpeneBayAddSubscriberRequestType.subscriptionId |
Element | Removed |
OpeneBayAddSubscriberResponseType.subscriptionStatus |
Element | Removed |
OpeneBayRemoveSubscriberRequestType.subscriptionId |
Element | Removed |
OpeneBaySubscriberInfoType.EIASToken |
Element | Removed |
OpeneBaySubscriberInfoType.authToken |
Element | Removed |
BaseOpeneBayParticipantInterfaceRequestType |
Complex type | New |
BaseOpeneBayParticipantInterfaceResponseType |
Complex type | New |
OpeneBayRequestCredentialsType |
Complex type | New |
OpeneBaySubscriptionInfoType |
Complex type | New |
AckValueType |
Enumerated type | New |
ErrorSeverityType |
Enumerated type | New |
OpeneBayAddSubscriberRequestType.subscriptionInfo |
Element | New |
OpeneBayAddSubscriberRequestType.userInfo |
Element | New |
OpeneBayAddSubscriberResponseType.message |
Element | New |
OpeneBayAddSubscriberResponseType.status |
Element | New |
OpeneBayAddSubscriberResponseType.subscriptionId |
Element | New |
OpeneBayRemoveSubscriberRequestType.subscriptionInfo |
Element | New |
OpeneBayRemoveSubscriberRequestType.userInfo |
Element | New |
OpeneBaySecurityTokenType.signature |
Element | New |
Please download the WSDL for version 1.2.0.
Developers should expect disruption to production access in late June and disruption to sandbox access in early July.
This section describes features that will be available at the following times:
In the addSubscriber and removeSubscriber calls, the
subscriptionInfo container has billing plan information. Additionally, the signature
and token values are now in a credentials container.
For more information about the schema changes, see the schema changes table, the Call Reference, and the WSDL for version 1.2.0. The Call Reference includes updated samples, as part of the addSubscriber and removeSubscriber topics.
The format of the addSubscriber and removeSubscriber calls has changed. For more information, see New Features - 1.2.0.
The documentation additions include updates to:
This is the first release of the OpeneBayParticipantInterface service.
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were provided in this release.
This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.
© 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.