Notification API — client.commerce.notification¶
Version v1.6.7 · base path /commerce/notification/v1 · async twin: the same methods on
AsyncEbayClient, awaited.
Operations¶
Bases: BaseResource
get_config ¶
get_config(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_notification_models.Config
get_config(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_config(*, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_notification_models.Config | httpx.Response
This method allows applications to retrieve a previously created configuration.
update_config ¶
update_config(*, body: Config | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_notification_models.Error
update_config(*, body: Config | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_config(*, body: Config | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_notification_models.Error | httpx.Response
This method allows applications to create a new configuration or update an existing configuration. This app-level configuration allows developers to set up alerts.
get_destinations ¶
get_destinations(*, continuation_token: str | None = None, limit: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_notification_models.DestinationSearchResponse
get_destinations(*, continuation_token: str | None = None, limit: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_destinations(*, continuation_token: str | None = None, limit: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_notification_models.DestinationSearchResponse | httpx.Response
This method allows applications to retrieve a paginated collection of destination resources and related details. The details include the destination names, statuses, and configurations, including the endpoints and verification tokens.
create_destination ¶
create_destination(*, body: DestinationRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> dict[str, Any]
create_destination(*, body: DestinationRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_destination(*, body: DestinationRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> dict[str, Any] | httpx.Response
This method allows applications to create a destination. A destination is an endpoint that receives HTTP push notifications. A single destination for all topics is valid, as is individual destinations for each topic. To update a destination, use the updateDestination call. The destination created will need to be referenced while creating or updating a subscription to a topic.
get_destination ¶
get_destination(destination_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_notification_models.Destination
get_destination(destination_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_destination(destination_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_notification_models.Destination | httpx.Response
This method allows applications to fetch the details for a destination. The details include the destination name, status, and configuration, including the endpoint and verification token.
update_destination ¶
update_destination(destination_id: str, *, body: DestinationRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_notification_models.Error
update_destination(destination_id: str, *, body: DestinationRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_destination(destination_id: str, *, body: DestinationRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_notification_models.Error | httpx.Response
This method allows applications to update a destination. Note: The destination should be created and ready to respond with the expected challengeResponse for the endpoint to be registered successfully.
delete_destination ¶
delete_destination(destination_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_notification_models.Error
delete_destination(destination_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
delete_destination(destination_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_notification_models.Error | httpx.Response
This method provides applications a way to delete a destination. The same destination ID can be used by many destinations. Trying to delete an active destination results in an error. You can disable a subscription, and when the destination is no longer in use, you can delete it.
get_public_key ¶
get_public_key(public_key_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_notification_models.PublicKey
get_public_key(public_key_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_public_key(public_key_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_notification_models.PublicKey | httpx.Response
This method allows users to retrieve a public key using a specified key ID. The public key that is returned in the response payload is used to process and validate eBay notifications. The public key ID, which is a required request parameter for this method, is retrieved from the Base64-encoded X-EBAY-SIGNATURE header that is included in the eBay notification.
get_subscriptions ¶
get_subscriptions(*, continuation_token: str | None = None, limit: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_notification_models.SubscriptionSearchResponse
get_subscriptions(*, continuation_token: str | None = None, limit: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_subscriptions(*, continuation_token: str | None = None, limit: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_notification_models.SubscriptionSearchResponse | httpx.Response
This method allows applications to retrieve a list of all subscriptions. The list returned is a paginated collection of subscription resources. Subscriptions allow applications to express interest in notifications and keep receiving the information relevant to their business.
create_subscription ¶
create_subscription(*, body: CreateSubscriptionRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> dict[str, Any]
create_subscription(*, body: CreateSubscriptionRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_subscription(*, body: CreateSubscriptionRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> dict[str, Any] | httpx.Response
This method allows applications to create a subscription for a topic and supported schema version. Subscriptions allow applications to express interest in notifications and keep receiving the information relevant to their business. Each application and topic-schema pairing to a subscription should have a 1:1 cardinality.
create_subscription_filter ¶
create_subscription_filter(subscription_id: str, *, body: CreateSubscriptionFilterRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> dict[str, Any]
create_subscription_filter(subscription_id: str, *, body: CreateSubscriptionFilterRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_subscription_filter(subscription_id: str, *, body: CreateSubscriptionFilterRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> dict[str, Any] | httpx.Response
This method allows applications to create a filter for a subscription. Filters allow applications to only be sent notifications that match a provided criteria. Notifications that do not match this criteria will not be sent to the destination. The filterSchema value must be a valid JSON Schema Core document (version 2020-12 or later).
get_subscription ¶
get_subscription(subscription_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_notification_models.Subscription
get_subscription(subscription_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_subscription(subscription_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_notification_models.Subscription | httpx.Response
This method allows applications to retrieve subscription details for the specified subscription. Specify the subscription to retrieve using the subscription_id . Use the getSubscriptions method to browse all subscriptions if you do not know the subscription_id . Subscriptions allow applications to express interest in notifications and keep receiving the information relevant to their business.
update_subscription ¶
update_subscription(subscription_id: str, *, body: UpdateSubscriptionRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_notification_models.Error
update_subscription(subscription_id: str, *, body: UpdateSubscriptionRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
update_subscription(subscription_id: str, *, body: UpdateSubscriptionRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_notification_models.Error | httpx.Response
This method allows applications to update a subscription. Subscriptions allow applications to express interest in notifications and keep receiving the information relevant to their business. Note: This call returns an error if an application is not authorized to subscribe to a topic. You can pause and restart a subscription. See the disableSubscription and enableSubscription methods.
delete_subscription ¶
delete_subscription(subscription_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_notification_models.Error
delete_subscription(subscription_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
delete_subscription(subscription_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_notification_models.Error | httpx.Response
This method allows applications to delete a subscription. Subscriptions can be deleted regardless of status.
get_subscription_filter ¶
get_subscription_filter(filter_id: str, subscription_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_notification_models.SubscriptionFilter
get_subscription_filter(filter_id: str, subscription_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_subscription_filter(filter_id: str, subscription_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_notification_models.SubscriptionFilter | httpx.Response
This method allows applications to retrieve the filter details for the specified subscription filter. Specify the subscription filter to retrieve by using the subscription_id and the filter_id associated with the subscription filter. The filter_id can be found in the response body for the getSubscription method, if there is a filter applied on the subscription.
delete_subscription_filter ¶
delete_subscription_filter(filter_id: str, subscription_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_notification_models.Error
delete_subscription_filter(filter_id: str, subscription_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
delete_subscription_filter(filter_id: str, subscription_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_notification_models.Error | httpx.Response
This method allows applications to disable the active filter on a subscription, so that a new subscription filter may be added. Note: Subscription filters in PENDING status can not be disabled. However, a new filter can be created instead with the createSubscriptionFilter method and this new filter will override the PENDING filter.
disable_subscription ¶
disable_subscription(subscription_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_notification_models.Error
disable_subscription(subscription_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
disable_subscription(subscription_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_notification_models.Error | httpx.Response
This method disables a subscription, which prevents the subscription from providing notifications. To restart a subscription, call enableSubscription .
enable_subscription ¶
enable_subscription(subscription_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_notification_models.Error
enable_subscription(subscription_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
enable_subscription(subscription_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_notification_models.Error | httpx.Response
This method allows applications to enable a disabled subscription. To pause (or disable) an enabled subscription, call disableSubscription .
test_subscription ¶
test_subscription(subscription_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_notification_models.Error
test_subscription(subscription_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
test_subscription(subscription_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_notification_models.Error | httpx.Response
This method triggers a mocked test payload that includes a notification ID, publish date, and so on. Use this method to test your subscription end-to-end. You can create the subscription in disabled mode, test it using this method, and when everything is ready, you can enable the subscription (see the enableSubscription method).
get_topic ¶
get_topic(topic_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_notification_models.Topic
get_topic(topic_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_topic(topic_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_notification_models.Topic | httpx.Response
This method allows applications to retrieve details for the specified topic. This information includes supported schema versions, formats, and other metadata for the topic. Applications can subscribe to any of the topics for a supported schema version and format, limited by the authorization scopes required to subscribe to the topic.
get_topics ¶
get_topics(*, continuation_token: str | None = None, limit: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_notification_models.TopicSearchResponse
get_topics(*, continuation_token: str | None = None, limit: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_topics(*, continuation_token: str | None = None, limit: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_notification_models.TopicSearchResponse | httpx.Response
This method returns a paginated collection of all supported topics, along with the details for the topics. This information includes supported schema versions, formats, and other metadata for the topics. Applications can subscribe to any of the topics for a supported schema version and format, limited by the authorization scopes required to subscribe to the topic.
Models¶
Config ¶
Bases: EbayModel
alert_email
class-attribute
instance-attribute
¶
alert_email = Field(None, alias='alertEmail', description='This field is used to add or modify an email address that will be used for Notification API alerts associated with the application. getConfig can be used to get the email address currently being used for alerts.')
ContextEnum ¶
CreateSubscriptionFilterRequest ¶
Bases: EbayModel
filter_schema
class-attribute
instance-attribute
¶
filter_schema = Field(None, alias='filterSchema', description="The content of a subscription filter as a valid JSON Schema Core document (version 2020-12 or later). The filterSchema provided must describe the subscription's notification payload such that it supplies valid criteria to filter the subscription's notifications. Note: Not all topics can have filters applied to them.")
DeliveryConfig ¶
Bases: EbayModel
endpoint
class-attribute
instance-attribute
¶
endpoint = Field(None, description='The endpoint for this destination. Note: The provided endpoint URL should use the HTTPS protocol, and it should not contain an internal IP address or localhost in its path.')
verification_token
class-attribute
instance-attribute
¶
verification_token = Field(None, alias='verificationToken', description='The verification token associated with this endpoint. Note: The provided verification token must be between 32 and 80 characters. Allowed characters include alphanumeric characters, underscores ( _ ), and hyphens ( - ); no other characters are allowed.')
DestinationStatusEnum ¶
ErrorParameter ¶
PublicKey ¶
Bases: EbayModel
algorithm
class-attribute
instance-attribute
¶
algorithm = Field(None, description='The algorithm associated with the public key that is returned, such as Elliptic Curve Digital Signature Algorithm (ECDSA).')
digest
class-attribute
instance-attribute
¶
digest = Field(None, description='The digest associated with the public key that is returned, such as Secure Hash Algorithm 1 (SHA1).')
key
class-attribute
instance-attribute
¶
key = Field(None, description='The public key that is returned for the specified key ID. This value is used to validate the eBay push notification message payload.')
ScopeEnum ¶
StatusEnum ¶
SubscriptionFilterStatus ¶
SubscriptionPayloadDetail ¶
Bases: EbayModel
delivery_protocol
class-attribute
instance-attribute
¶
delivery_protocol = Field(None, alias='deliveryProtocol', description='The supported delivery protocol of the notification topic. Note: HTTPS is currently the only supported delivery protocol of all notification topics.')
format
class-attribute
instance-attribute
¶
format = Field(None, description='The supported data format of the payload. Note: JSON is currently the only supported format for all notification topics.')
schema_version
class-attribute
instance-attribute
¶
schema_version = Field(None, alias='schemaVersion', description='The supported schema version for the notification topic. See the supportedPayloads.schemaVersion field for the topic in getTopics or getTopic response.')
SubscriptionStatusEnum ¶
SubscriptionTestResponse ¶
Bases: EbayModel
notification_id
class-attribute
instance-attribute
¶
notification_id = Field(None, alias='notificationId', description='The unique identifier for the notification for this test message.')
UpdateSubscriptionRequest ¶
Bases: EbayModel
destination_id
class-attribute
instance-attribute
¶
destination_id = Field(None, alias='destinationId', description='The unique identifier of the destination endpoint that will receive notifications associated with this subscription. Use getDestinations to retrieve destination IDs.')
payload
class-attribute
instance-attribute
¶
payload = Field(None, description='The payload associated with this subscription.')
status
class-attribute
instance-attribute
¶
status = Field(None, description='Set the status of the subscription being updated to ENABLED or DISABLED .')
CreateSubscriptionRequest ¶
Bases: EbayModel
destination_id
class-attribute
instance-attribute
¶
destination_id = Field(None, alias='destinationId', description='The unique identifier of the destination endpoint that will receive notifications associated with this subscription. Use the getDestinations method to retrieve destination IDs.')
payload
class-attribute
instance-attribute
¶
payload = Field(None, description='The payload associated with the notification topic. Use getTopics or getTopic to get the supported payload for the topic.')
status
class-attribute
instance-attribute
¶
status = Field(None, description='Set the status of the subscription to ENABLED or DISABLED .')
topic_id
class-attribute
instance-attribute
¶
topic_id = Field(None, alias='topicId', description='The unique identifier of the notification topic to subscribe to. Use getTopics to get topic IDs.')
Destination ¶
Bases: EbayModel
delivery_config
class-attribute
instance-attribute
¶
delivery_config = Field(None, alias='deliveryConfig', description='The configuration associated with this destination.')
destination_id
class-attribute
instance-attribute
¶
destination_id = Field(None, alias='destinationId', description='The unique identifier for the destination.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='The name associated with this destination.')
status
class-attribute
instance-attribute
¶
status = Field(None, description='The status for this destination. Note: The MARKED_DOWN value is set by eBay systems and cannot be used in a create or update call by applications. Valid values: ENABLED DISABLED MARKED_DOWN')
DestinationRequest ¶
Bases: EbayModel
delivery_config
class-attribute
instance-attribute
¶
delivery_config = Field(None, alias='deliveryConfig', description='This container is used to specify the destination endpoint and verification token associated with this endpoint.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='The seller-specified name for the destination endpoint.')
status
class-attribute
instance-attribute
¶
status = Field(None, description='This field sets the status for the destination endpoint as ENABLED or DISABLED . Note: The MARKED_DOWN value is set by eBay systems and cannot be used in a create or update call by applications.')
DestinationSearchResponse ¶
Bases: EbayModel
destinations
class-attribute
instance-attribute
¶
destinations = Field(None, description='An array that contains the destination details.')
href
class-attribute
instance-attribute
¶
href = Field(None, description='The path to the call URI that produced the current page of results.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The number of records to show in the current response. Default: 20')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The URL to access the next set of results. This field includes a continuation_token . No prev field is returned, but this value is persistent during the session so that you can use it to return to the next page. This field is not returned if fewer records than specified by the limit field are returned.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of matches for the search criteria.')
Error ¶
Bases: EbayModel
category
class-attribute
instance-attribute
¶
category = Field(None, description='Identifies the type of error.')
domain
class-attribute
instance-attribute
¶
domain = Field(None, description='Name for the primary system where the error occurred. This is relevant for application errors.')
error_id
class-attribute
instance-attribute
¶
error_id = Field(None, alias='errorId', description='A unique number to identify the error.')
input_ref_ids
class-attribute
instance-attribute
¶
input_ref_ids = Field(None, alias='inputRefIds', description='An array of request elements most closely associated to the error.')
long_message
class-attribute
instance-attribute
¶
long_message = Field(None, alias='longMessage', description='A more detailed explanation of the error.')
message
class-attribute
instance-attribute
¶
message = Field(None, description="Information on how to correct the problem, in the end user's terms and language where applicable.")
output_ref_ids
class-attribute
instance-attribute
¶
output_ref_ids = Field(None, alias='outputRefIds', description='An array of request elements most closely associated to the error.')
parameters
class-attribute
instance-attribute
¶
parameters = Field(None, description='An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.')
subdomain
class-attribute
instance-attribute
¶
subdomain = Field(None, description='Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.')
PayloadDetail ¶
Bases: EbayModel
delivery_protocol
class-attribute
instance-attribute
¶
delivery_protocol = Field(None, alias='deliveryProtocol', description='The supported delivery protocols.')
deprecated
class-attribute
instance-attribute
¶
deprecated = Field(None, description='A deprecation indicator.')
format
class-attribute
instance-attribute
¶
format = Field(None, description='The supported format. Presently, JSON is the only supported format.')
schema_version
class-attribute
instance-attribute
¶
schema_version = Field(None, alias='schemaVersion', description='The supported schema version.')
Subscription ¶
Bases: EbayModel
creation_date
class-attribute
instance-attribute
¶
creation_date = Field(None, alias='creationDate', description='The creation date for this subscription.')
destination_id
class-attribute
instance-attribute
¶
destination_id = Field(None, alias='destinationId', description='The unique identifier for the destination associated with this subscription.')
filter_id
class-attribute
instance-attribute
¶
filter_id = Field(None, alias='filterId', description='The unique identifier for the filter associated with this subscription.')
payload
class-attribute
instance-attribute
¶
payload = Field(None, description='The payload associated with this subscription.')
status
class-attribute
instance-attribute
¶
status = Field(None, description='The status of this subscription.')
subscription_id
class-attribute
instance-attribute
¶
subscription_id = Field(None, alias='subscriptionId', description='The unique identifier for the subscription.')
topic_id
class-attribute
instance-attribute
¶
topic_id = Field(None, alias='topicId', description='The unique identifier for the topic associated with this subscription.')
SubscriptionFilter ¶
Bases: EbayModel
creation_date
class-attribute
instance-attribute
¶
creation_date = Field(None, alias='creationDate', description='The creation date for this subscription filter.')
filter_id
class-attribute
instance-attribute
¶
filter_id = Field(None, alias='filterId', description='The unique identifier for this subscription filter.')
filter_schema
class-attribute
instance-attribute
¶
filter_schema = Field(None, alias='filterSchema', description="The content of this subscription filter as a valid JSON Schema Core document (version 2020-12 or later). The filterSchema provided must describe the subscription's notification payload such that it supplies valid criteria to filter the subscription's notifications.")
filter_status
class-attribute
instance-attribute
¶
filter_status = Field(None, alias='filterStatus', description='The status of this subscription filter.')
subscription_id
class-attribute
instance-attribute
¶
subscription_id = Field(None, alias='subscriptionId', description='The unique identifier for the subscription.')
SubscriptionSearchResponse ¶
Bases: EbayModel
href
class-attribute
instance-attribute
¶
href = Field(None, description='The path to the call URI that produced the current page of results.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The value of the limit parameter submitted in the request, which is the maximum number of items to return per page, from the result set. A result set is the complete set of results returned by the method. Note: Though this parameter is not required to be submitted in the request, the parameter defaults to 20 if omitted. Default: 20')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The URL to access the next set of results. This field includes a continuation_token . No prev field is returned, but this value is persistent during the session so that you can use it to return to the next page. This field is not returned if fewer records than specified by the limit field are returned.')
subscriptions
class-attribute
instance-attribute
¶
subscriptions = Field(None, description='The subscriptions that match the search criteria.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of matches for the search criteria.')
Topic ¶
Bases: EbayModel
authorization_scopes
class-attribute
instance-attribute
¶
authorization_scopes = Field(None, alias='authorizationScopes', description='The authorization scopes required to subscribe to this topic.')
context
class-attribute
instance-attribute
¶
context = Field(None, description='The business context associated with this topic.')
description
class-attribute
instance-attribute
¶
description = Field(None, description='The description of the topic.')
filterable
class-attribute
instance-attribute
¶
filterable = Field(None, description='The indicator of whether this topic is filterable or not.')
scope
class-attribute
instance-attribute
¶
scope = Field(None, description='The scope of this topic.')
status
class-attribute
instance-attribute
¶
status = Field(None, description='The status of this topic.')
supported_payloads
class-attribute
instance-attribute
¶
supported_payloads = Field(None, alias='supportedPayloads', description='The supported payloads for this topic.')
topic_id
class-attribute
instance-attribute
¶
topic_id = Field(None, alias='topicId', description='The unique identifier for the topic.')
TopicSearchResponse ¶
Bases: EbayModel
href
class-attribute
instance-attribute
¶
href = Field(None, description='The path to the call URI that produced the current page of results.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The value of the limit parameter submitted in the request, which is the maximum number of items to return per page, from the result set. A result set is the complete set of results returned by the method. Note: Though this parameter is not required to be submitted in the request, the parameter defaults to 20 if omitted.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The URL to access the next set of results. This field includes a continuation_token . No prev field is returned, but this value is persistent during the session so that you can use it to return to the next page. This field is not returned if fewer records than specified by the limit field are returned.')
topics
class-attribute
instance-attribute
¶
topics = Field(None, description='An array of topics that match the specified criteria.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of matches for the search criteria.')