User Guide

The AppID of the receiving application. When you upload a deployment descriptor for your Selling Manager application, you provide a value (as myapp.mycompany.com) that becomes your AppID in the keys that are issued for your application. For information about uploading a deployment descriptor, see the User's Guide. 128 addSubscriber removeSubscriber updateSubscriber Yes Container for signature and tokenValue. 1000 addSubscriber removeSubscriber updateSubscriber Yes Used to specify whether a token is passed by value or by reference. Applications should expect it to be passed by value. The token is passed by reference; reserved for future use. The token is passed by value. A base64-encoded string that you must decrypt before extracting values. In the case of addSubscriber, the values that you extract include the following for the user to be added as a subscriber to your application: the user name and the user Auth token (that is, the Auth and Auth token used in the Trading API). In the case of removeSubscriber, values that you extract (for the user to remove) include the user name. 2000 addSubscriber removeSubscriber updateSubscriber Yes ../../selling-manager-applications/Concepts/SellingManagerApps_APIGuide.html User Guide values contained in tokenValue, and instructions on decrypting and parsing tokenValue An RSA-encrypted string by which you can verify that the request is from eBay. You decrypt this string with the public eBay key. For more information, and the location of the public key, see the link below. addSubscriber removeSubscriber updateSubscriber Yes ../../selling-manager-applications/Concepts/SellingManagerApps_APIGuide.html#subscribers User Guide instructions on using signature The base type for tokens. 1000 addSubscriber removeSubscriber Yes Base type for the request container for service operations. Container for signature and tokenValue. addSubscriber removeSubscriber updateSubscriber Yes Base response container for service operations. Indicates whether there are any errors or warnings associated with the processing of the request. Always After you decide how your implementation of this service will define errors, you can decide whether to use this container. eBay does not inspect the value of this errorMessage field. Conditionally Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user. Conditionally The date and time the request was processed. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM- DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Always Indicates whether the issue is an error (causing the request to fail) or a warning. The request was processed successfully, but something occurred that may affect your application or the user. The request that triggered the error was not processed successfully. When a serious application-level error occurs, an error is returned instead of business data. The request that triggered the error was processed successfully but with some warnings. The request that triggered the error was processed successfully but with some warnings. Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user. The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data. The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning. Container for an eBay user name, provided for convenience. Instead using the value in this container, use the value in tokenValue. The user name of an eBay user, provided for convenience. Instead of using this value for the user name, use the value in tokenValue. 64 addSubscriber removeSubscriber updateSubscriber Yes Container for information about a change in the state of a subscription. The state that the subscription was in, before eBay detected that a change occurred. updateSubscriber Yes The new state of a subscription. This value is sent by eBay; eBay sends an updateSubscriber request to your application when a change in a user's subscription state is detected. For example, eBay sends an updateSubscriber request to your application if, due to a payment failure, a user's subscription goes into a suspended state. updateSubscriber Yes A message about the reason for the change in state of the subscription. Depending on how the subscription state was changed, this message may have been manually entered (as part of the change) or may have been auto-generated. updateSubscriber Yes The subscription status of an eBay user, according to your application. Subscription status is approved, according to your application. If you specify this value, eBay sets the user's subscription to Active. Subscription status is pending, according to your application. If you specify this value, eBay takes no action. Subscription status is rejected, according to your application. If you specify this value in an addSubscriber response, it means that, for whatever reason, your application is not accepting the subscription specified by eBay in the addSubscriber request. If eBay receives an addSubscriber response with a status of Rejected, eBay will set the user's subscription status to Rejected. The subscription status of an eBay user. Reserved for future use. Pending state. The subscription is not yet in the Active state. Active state, i.e. actively subscribed to an application. Suspended state, e.g. due to a payment failure or past due account. There is a block (that can be removed) on the user's access to the application. That is, the user cannot start the application. Cancelled state, i.e. unsubscribed from an application. Rejected state. One of the following has occurred: your application rejected the subscription (after receiving an addSubscriber call), or the subscription was manually changed (by the third-party application developer) to the rejected state. Reserved for future use. Container for subscription-related information. For a particular application, the subscriptionId uniquely identifies a user's subscription. 38 addSubscriber removeSubscriber updateSubscriber Yes A planId is assigned by eBay to each subscription plan. Your application often uses this value in calls to the Open eBay Application Integration Service. Note that the planId is diffrent from the externalPlanId. In contrast to the planId, the externalPlanId is the value that you provide, as a "Developer Plan ID," when you create a subscription plan. 38 addSubscriber removeSubscriber updateSubscriber No The plan name that you provided for your subscription plan when you created the plan. This plan name is provided in the call request to help you read log files, during debugging. Instead of using this value for programmatically identifying the subscription plan, use value in the externalPlanId field. 128 addSubscriber removeSubscriber updateSubscriber Yes When you create a subscription plan, you provide a Developer Plan ID. That Developer Plan ID is contained in this externalPlanId field. (For users to subscribe to your application, you must create at least one subscription plan.) In this call, the externalPlanId identifies the plan to which a user has subscribed. Note that if you are running an application in the sandbox, a subscription plan, and an associated value for the Developer Plan ID, are created for you. You can create others plans, if desired, with different Developer Plan IDs. 128 addSubscriber removeSubscriber updateSubscriber Yes Reserved for future use. Sent by eBay to request that you add an eBay member to your subscription database. eBay sends this request after a user completes the subscription flow. The subscription flow is accessible from the Selling Applications Directory. Your application must use a subscription listener to receive addSubscriber requests from eBay. When you receive an addSubscriber request, your application responds with a status value, indicating the subscription status of the user in your database.

Sent by eBay to request that you add an eBay member to your subscription database.

../../selling-manager-applications/Concepts/SellingManagerApps_APIGuide.html#subscribers User Guide information about a subscription listener samples Container for a field that indicates the user name of an eBay user. addSubscriber updateSubscriber Yes Container for subscription-related information. addSubscriber updateSubscriber Yes Contains a response to an addSubscriber call. For a particular application, the subscriptionId uniquely identifies a user's subscription. addSubscriber removeSubscriber Conditionally The status of the subscription, according to your application. For example, when you receive an addSubscriber request, your application's response includes this field to indicate the latest subscription status of the user, according to your database. This status value initially is set by your application, unlike the subscriptionStateChangeInfo.newState value, which is set by eBay. When eBay receives this status value from your application, eBay sets the subscription to Active, Pending, or Rejected, depending on the status value you send in the response. addSubscriber removeSubscriber Always Message about the subscription status. addSubscriber removeSubscriber Always Sent by eBay to request that you update information about an eBay member in your subscription database. This call always applies to an existing subscription. eBay sends an updateSubscriber call to your application when eBay detects a change in a subscription state for a user. For example, if an SM Apps developer changes a user's subscription state using the Embedded Applications tab (at the Developers Program website), eBay sends an updateSubscriber call to your application.

Sent by eBay to request that you update information about an eBay member in your subscription database.

Sent by eBay to request that you remove an eBay member from your subscription database.