Skip to main content
Guides
Release Notes
Request Headers
Notifications
Response Status and Error Codes

Notifications

Notifications (events) are JSON payloads delivered to your webhook endpoint when something important happens in an eBay workflow. Browse events by functional group below, expand an event to view payload fields, headers, and the AsyncAPI spec.

Access and Scope Requirements

Some topics in the Commerce Notification API are restricted and require specific OAuth scopes. Access to these topics is controlled and may only be available to approved partners. To determine the required scope(s) for each topic, use the getTopics method. This method returns the list of available topics along with the OAuth scopes needed to subscribe to them. Please review the scope requirements carefully before integrating, as your application must be authorized with the appropriate scopes to access certain topics.

How to subscribe:

To receive notifications, subscribe to the topic(s) you care about and register a public HTTPS endpoint. Your endpoint should validate delivery and handle retries safely (idempotency).

See: Subscribing to notifications

Listing Management

Listing-related notifications applicable for buyers and sellers

ITEM_AVAILABILITY
Sent when a fixed-price item’s availability type changes.

A subscription for this topic initiates notifications being sent to a developer when a fixed-price item's availability type changes.

Supported availability types are:

  • AVAILABLE
  • UNAVAILABLE
  • TEMPORARILY_UNAVAILABLE

Note: Currently, this topic is available for eBay Partner Network (ePN) partners in all marketplaces except the following: CA, AU, HK, SG, MY, and PH.

Delivery
Method
HTTPS webhook (POST)
Retries
3
HTTP headers
  • X-EBAY-SIGNATURE

    ECC message signature

Types
  • MetaData

    This type specifies the metadata included with the notification.

    topicstring

    This is the unique identifier of the Notification topic.

    schemaVersionstring

    This specifies the version number of the topic schema.

    deprecatedboolean

    This boolean field indicates whether or not the topic is active or deprecated.

  • Notification

    This type includes information about the notification.

    notificationIdstring

    This is the unique identifier of the specific notification.

    eventDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the event that triggered the notification was sent to the recipient.

    publishDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the notification was sent to the recipient.

    publishAttemptCountinteger

    This integer value indicates whether this is the first, second, or third attempt to send the notification to the recipient. When a notification is sent successfully the first time, the integer value returned will be 1.

    dataItemAvailabilityData

    This container consists of specific information related to the item availability data.

  • ItemAvailabilityData

    This type encompasses the Item Availability payload.

    itemIdstring

    This is the ID for the item.

    listingMarketplaceIdstring

    This enumeration type is used to indicate the eBay marketplace where the item is listed.

    Possible Values:
    ValueDescription
    EBAY_USThis value indicates that the listing is on the eBay US marketplace.
    EBAY_GBThis value indicates that the listing is on the eBay UK marketplace.
    EBAY_AUThis value indicates that the listing is on the eBay Australia marketplace.
    EBAY_ATThis value indicates that the listing is on the eBay Austria marketplace.
    EBAY_FRThis value indicates that the listing is on the eBay France marketplace.
    EBAY_DEThis value indicates that the listing is on the eBay Germany marketplace.
    EBAY_ITThis value indicates that the listing is on the eBay Italy marketplace
    EBAY_BEThis value indicates that the listing is on the eBay Belgium marketplace.
    EBAY_NLThis value indicates that the listing is on the eBay Netherlands marketplace.
    EBAY_ESThis value indicates that the listing is on the eBay Spain marketplace.
    EBAY_CHThis value indicates that the listing is on the eBay Switzerland marketplace.
    EBAY_HKThis value indicates that the listing is on the eBay Hong Kong marketplace.
    EBAY_IEThis value indicates that the listing is on the eBay Ireland marketplace.
    EBAY_MYThis value indicates that the listing is on the eBay Malaysia marketplace.
    EBAY_CAThis value indicates that the listing is on the eBay Canada marketplace.
    EBAY_PHThis value indicates that the listing is on the eBay Philippines marketplace.
    EBAY_PLThis value indicates that the listing is on the eBay Poland marketplace.
    EBAY_SGThis value indicates that the listing is on the eBay Singapore marketplace.
    buyingOptionsarray

    This array shows the list of the purchase options available to the buyer to purchase the item.

    Possible Values:
    ValueDescription
    FIXED_PRICEThis value indicates that the item can be directly purchased through a fixed price listing.
    AUCTIONThis value indicates that the buyer can win the item through an auction listing by being the highest bidder at the end of the auction.
    BEST_OFFERThis value indicates that the buyer can propose a Best Offer to the seller for the item.
    sellerSeller

    This object includes the seller information.

    categoryIdstring

    The unique identifier of the eBay primary (leaf) category.

    metaCategoryIdstring

    The unique identifier of the parent category of the leaf category defined in the categoryId field.

    categoryNamestring

    The canonical name of the primary (leaf) category.

    categoryPathstring

    The full path to the primary (leaf) category

    availabilitystring

    The enum returned here indicates the current availability of the item.

    Possible Values:
    ValueDescription
    TEMPORARILY_UNAVAILABLEThis value indicates that the item can’t be purchased through the listing at the moment, which could be due to the seller having their account set to vacation mode or the item being out of stock.
    AVAILABLEThis value indicates that the item is available for purchase through the listing.
    UNAVAILABLEThis value indicates that the item is no longer available and isn’t expected to be available any longer under that listing ID due to listing being ended.
  • Seller

    This object includes the seller information.

    usernamestring

    This string is the username of the seller.

    Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance.

Response
{ /* object */
"metadata" :
{ /* MetaData */
"topic" : "string",
"schemaVersion" : "string",
"deprecated" : "boolean"
},
"notification" :
{ /* Notification */
"notificationId" : "string",
"eventDate" : "string",
"publishDate" : "string",
"publishAttemptCount" : "integer",
"data" :
{ /* ItemAvailabilityData */
"itemId" : "string",
"listingMarketplaceId" : "string : [EBAY_US, EBAY_GB, EBAY_AU...]",
"buyingOptions" : "array : [FIXED_PRICE,AUCTION,BEST_OFFER]",
"seller" :
{ /* Seller */
"username" : "string"
},
"categoryId" : "string",
"metaCategoryId" : "string",
"categoryName" : "string",
"categoryPath" : "string",
"availability" : "string : [TEMPORARILY_UNAVAILABLE,AVAILABLE,UNAVAILABLE]"
}
}
}
LISTING_PREVIEW_CREATION_TASK_STATUS
Notification to sellers when a listing preview creation task is complete.

A subscription for this topic initiates notifications being sent to sellers to inform them when any of their listing preview creation tasks have completed.

OAuth Scope
In addition to the standard OAuth scope (https://api.ebay.com/oauth/api_scope), this topic requires an access token created using the Authorization Code Grant flow with the following scope:
https://api.ebay.com/oauth/api_scope/sell.inventory.mapping

See Working with OAuth scopes for more information.

Delivery
Method
HTTPS webhook (POST)
Retries
3
HTTP headers
  • X-EBAY-SIGNATURE

    The ECC message signature. This signature is used to process and validate the message payload.

Types
  • Metadata

    This type specifies the metadata included with the notification.

    topicstring

    This is the unique identifier of the Notification topic.

    schemaVersionstring

    This specifies the version number of the topic schema.

    deprecatedboolean

    This boolean field indicates whether or not the topic is active or deprecated.

  • Notification

    This type includes information about the notification.

    notificationIdstring

    This is the unique identifier of the specific notification.

    eventDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the event that triggered the notification was sent to the recipient.

    publishDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the notification was sent to the recipient.

    publishAttemptCountinteger

    This integer value indicates whether this is the first, second, or third attempt to send the notification to the recipient. When a notification is sent successfully the first time, the integer value returned will be 1.

    dataListingPreviewCreationTaskStatus

    This container consists of specific information related to the listing preview creation task status.

  • ListingPreviewCreationTaskStatus

    This type is the payload for the Listing Preview Creation Task Status Notification.

    userUser

    The user details for the notification subscriber.

    taskIdstring

    The unique identifier of the task. It is an opaque alphanumeric string with a limit of 25 characters.

    taskStatusstring

    Below is the list of enums that may be returned in this field that indicate the completion status of the task.

    Possible Values:
    ValueDescription
    COMPLETEDThe listing preview creation task was completed with no errors.
    FAILEDThe listing preview creation task failed to create the listing preview.
    COMPLETED_WITH_ERRORThe listing preview creation task was completed but an error occurred that could affect the listing preview.
  • User

    This object specifies the user details for the notification subscriber.

    userIdstring

    The unique identifier for the user.

    usernamestring

    The username associated with the user.

    Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance.

Response
{ /* object */
"metadata" :
{ /* Metadata */
"topic" : "string",
"schemaVersion" : "string",
"deprecated" : "boolean"
},
"notification" :
{ /* Notification */
"notificationId" : "string",
"eventDate" : "string",
"publishDate" : "string",
"publishAttemptCount" : "integer",
"data" :
{ /* ListingPreviewCreationTaskStatus */
"user" :
{ /* User */
"userId" : "string",
"username" : "string"
},
"taskId" : "string",
"taskStatus" : "string : [COMPLETED,FAILED,COMPLETED_WITH_ERROR]"
}
}
}
LISTING
Notification to sellers when a listing is created, updated, or ended.

A subscription for this topic initiates listing-related notifications being sent to a seller.

Notifications which may be sent include the following:

  • CREATED

  • UPDATED

  • ENDED

OAuth Scope
In addition to the standard OAuth scope (https://api.ebay.com/oauth/api_scope), this topic requires an access token created using the Authorization Code Grant flow with the following scope:
https://api.ebay.com/oauth/api_scope/sell.listing.read

See Working with OAuth scopes for more information.

Delivery
Method
HTTPS webhook (POST)
Retries
3
HTTP headers
  • X-EBAY-SIGNATURE

    The ECC message signature. This signature is used to process and validate the message payload.

Types
  • Metadata

    This type specifies the metadata included with the notification.

    topicstring

    This is the unique identifier of the Notification topic.

    schemaVersionstring

    This specifies the version number of the topic schema.

    deprecatedboolean

    This boolean field indicates whether or not the topic is active or deprecated.

  • Notification

    This type includes information about the notification.

    notificationIdstring

    This is the unique identifier of the specific notification.

    eventDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the event that triggered the notification was sent to the recipient.

    publishDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the notification was sent to the recipient.

    publishAttemptCountinteger

    This integer value indicates whether this is the first, second, or third attempt to send the notification to the recipient. When a notification is sent successfully the first time, the integer value returned will be 1.

    dataSellerListingNotificationsData

    This container consists of specific information related to the listing notification data.

  • SellerListingNotificationsData

    The payload for the Listing notification.

    listingIdstring

    The unique identifier of the listing that has been created, updated, or has ended. The reason field indicates which event took place.

    reasonstring

    The value returned here indicates whether the listing was created, updated, or ended.

    Possible Values:
    ValueDescription
    CREATEDThis value indicates the listing was just created and made active on eBay.
    UPDATEDThis value indicates an existing seller listing was modified (e.g., price, quantity, or other details changed).
    ENDEDThis value indicates the listing has finished and is no longer active or available to buyers.
    userUser

  • User

    The user information for the notification subscriber.

    userIdstring

    The unique identifier for the subscribed user.

    usernamestring

    The username associated with the subscribed user.

    Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance.

Response
{ /* object */
"metadata" :
{ /* Metadata */
"topic" : "string",
"schemaVersion" : "string",
"deprecated" : "boolean"
},
"notification" :
{ /* Notification */
"notificationId" : "string",
"eventDate" : "string",
"publishDate" : "string",
"publishAttemptCount" : "integer",
"data" :
{ /* SellerListingNotificationsData */
"listingId" : "string",
"reason" : "string : [CREATED,UPDATED,ENDED]",
"user" :
{ /* User */
"userId" : "string",
"username" : "string"
}
}
}
}
Account Management

Account Management-related notifications applicable for buyers and sellers

SELLER_STANDARDS_PROFILE_METRICS
Sent when critical seller performance metrics or seller level changes.

A subscription for this topic initiates notifications being sent to sellers to inform them about critical changes to their seller performance metrics and seller level, including proactive warnings when their performance metrics are close to the threshold that could change the seller's standard level.

OAuth Scope
In addition to the standard OAuth scope (https://api.ebay.com/oauth/api_scope), this topic requires an access token created using the Authorization Code Grant flow with the following scope:
https://api.ebay.com/oauth/api_scope/sell.analytics.readonly

See Working with OAuth scopes for more information.

Delivery
Method
HTTPS webhook (POST)
Retries
3
HTTP headers
  • X-EBAY-SIGNATURE

    The ECC message signature. This signature is used to process and validate the message payload.

Types
  • Metadata

    This type specifies the metadata included with the notification.

    topicstring

    This is the unique identifier of the Notification topic.

    schemaVersionstring

    This specifies the version number of the topic schema.

    deprecatedboolean

    This boolean field indicates whether or not the topic is active or deprecated.

  • Notification

    This type includes information about the notification.

    notificationIdstring

    This is the unique identifier of the specific notification.

    eventDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the event that triggered the notification was sent to the recipient.

    publishDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the notification was sent to the recipient.

    publishAttemptCountinteger

    This integer value indicates whether this is the first, second, or third attempt to send the notification to the recipient. When a notification is sent successfully the first time, the integer value returned will be 1.

    dataSellerStandardNotificationMetricsData

    This container consists of specific information related to each occurrence of this notification topic.

  • SellerStandardNotificationMetricsData

    This type defines the payload for the Seller Standards Profile Metrics notification.

    userUser

    This object is the user details for the notification subscriber.

    cyclestring

    Below is the list of enums that may be returned in this field to indicate the evaluation cycle used for the seller standards profile metrics.

    Possible Values:
    ValueDescription
    CURRENTThis value indicates that the seller standards profile metrics are based off of the last official monthly seller standards profile metrics report. The current seller standards profile metrics report is what determines a seller’s current seller level and customer-service ratings.
    PROJECTEDThis value indicates that the seller standards profile metrics are indicative of what the seller level and customer-service ratings would be if they were evaluated at this point in time.
    programsarray of Program

    This array is a list of programs associated with the seller.

  • User

    This object specifies the user details for the notification subscriber.

    userIdstring

    This string is the unique identifier for the user.

    usernamestring

    This string is the username associated with the user.

    Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance.

  • Program

    This object provides more information about the eBay Standards Program and the cycle used for the metrics.

    programNamestring

    Below is the list of enums that may be returned in this field to indicate the eBay Seller Standards program that is being used.

    Possible Values:
    ValueDescription
    PROGRAM_USThis value indicates that the Seller Standards program on the eBay US marketplace is being used for the evaluation.
    PROGRAM_UKThis value indicates that the Seller Standards program on the eBay UK marketplace is being used for the evaluation.
    PROGRAM_DEThis value indicates that the Seller Standards program on the eBay German marketplace is being used for the evaluation.
    PROGRAM_GLOBALThis value indicates that the global Seller Standards program is being used for the evaluation.
    changeTypeChangeType

    This container indicates whether the Seller Level and/or one or more seller standards metrics changed for a seller.

    currentStandardProfile

    This container provides details on seller level and seller standard metrics if the evaluation cycle is set to CURRENT, which means that these metrics are based on the report from the last evaluation period.

    projectedStandardProfile

    This container provides details on seller level and seller standard metrics if the evaluation cycle is set to PROJECTED, which means that these metrics are based on projections from the current evaluation period.

Response
{ /* object */
"metadata" :
{ /* Metadata */
"topic" : "string",
"schemaVersion" : "string",
"deprecated" : "boolean"
},
"notification" :
{ /* Notification */
"notificationId" : "string",
"eventDate" : "string",
"publishDate" : "string",
"publishAttemptCount" : "integer",
"data" :
{ /* SellerStandardNotificationMetricsData */
"user" :
{ /* User */
"userId" : "string",
"username" : "string"
},
"cycle" : "string : [CURRENT,PROJECTED]",
"programs" : [
{ /* Program */
"programName" : "string : [PROGRAM_US, PROGRAM_UK, PROGRAM_DE...]",
"changeType" :
{ /* ChangeType */
"change" : [
"string"
],
"metricKey" : [
"string"
]
},
"current" :
{ /* StandardProfile */
"standardLevel" : "string : [ABOVE_STANDARD,BELOW_STANDARD,TOP_RATED]",
"evaluationDate" : "string",
"evaluationMonth" : "string",
"metrics" : [
{ /* Metric */
"metricKey" : "string : [DEFECTIVE_TRANSACTION_RATE, CLAIMS_SAF_RATE, VALID_TRACKING_UPLOADED_WITHIN_HANDLING_RATE...]",
"value" : "string",
"level" : "string : [ABOVE_STANDARD,BELOW_STANDARD,TOP_RATED]",
"lookbackStartDate" : "string",
"lookbackEndDate" : "string",
"type" : "string : [AMOUNT, BOOLEAN, DATE...]",
"thresholdLowerBound" : "string",
"thresholdMetaData" : "string",
"thresholdUpperBound" : "string"
}
]
},
"projected" :
{ /* StandardProfile */
"standardLevel" : "string : [ABOVE_STANDARD,BELOW_STANDARD,TOP_RATED]",
"evaluationDate" : "string",
"evaluationMonth" : "string",
"metrics" : [
{ /* Metric */
"metricKey" : "string : [DEFECTIVE_TRANSACTION_RATE, CLAIMS_SAF_RATE, VALID_TRACKING_UPLOADED_WITHIN_HANDLING_RATE...]",
"value" : "string",
"level" : "string : [ABOVE_STANDARD,BELOW_STANDARD,TOP_RATED]",
"lookbackStartDate" : "string",
"lookbackEndDate" : "string",
"type" : "string : [AMOUNT, BOOLEAN, DATE...]",
"thresholdLowerBound" : "string",
"thresholdMetaData" : "string",
"thresholdUpperBound" : "string"
}
]
}
}
]
}
}
}
AUTHORIZATION_REVOCATION
Sent to developers when a user revokes Developers Program permissions.

A subscription for this topic initiates notifications being sent to a developer when an eBay user revokes permissions for their eBay Developers Program application.

Delivery
Method
HTTPS webhook (POST)
Retries
3
HTTP headers
  • X-EBAY-SIGNATURE

    ECC message signature

Types
  • MetaData

    This type specifies the metadata included with the notification.

    topicstring

    This is the unique identifier of the Notification topic.

    schemaVersionstring

    This specifies the version number of the topic schema.

    deprecatedboolean

    This boolean field indicates whether or not the topic is active or deprecated.

  • Notification

    This type includes information about the notification.

    notificationIdstring

    This is the unique identifier of the specific notification.

    eventDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the event that triggered the notification was sent to the recipient.

    publishDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the notification was sent to the recipient.

    publishAttemptCountinteger

    This integer value indicates whether this is the first, second, or third attempt to send the notification to the recipient. When a notification is sent successfully the first time, the integer value returned will be 1.

    dataAuthorizationRevocationData

    This container consists of specific information related to the authorization revocation data.

  • AuthorizationRevocationData

    This type defines the Authorization Revocation payload.

    usernamestring

    This string contains the username for the user.

    Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance.

    userIdstring

    The immutable public userId for the user.

    eiasTokenstring

    The legacy eiasToken specific to the user.

    revokeReasonstring

    Below is the list of enums that may be returned in this field as reasons an authorization revocation has occurred.

    Possible Values:
    ValueDescription
    REVOKED_BY_APPThis value indicates that your application itself revoked the user’s authorization (for example, via a token-revocation call).
    REVOKED_BY_USERThis value indicates that the user manually revoked your app’s access from their eBay account settings.
    REVOKED_BY_EBAYThis value indicates that eBay revoked the authorization, typically due to security, policy, or compliance concerns.
    PASSWORD_CHANGEThis value indicates that the user changed their eBay password or login name, which caused their existing tokens to be automatically revoked.
    revocationDatestring

    This timestamp that indicates the date and time (in UTC format) when the authorization was revoked.

Response
{ /* object */
"metadata" :
{ /* MetaData */
"topic" : "string",
"schemaVersion" : "string",
"deprecated" : "boolean"
},
"notification" :
{ /* Notification */
"notificationId" : "string",
"eventDate" : "string",
"publishDate" : "string",
"publishAttemptCount" : "integer",
"data" :
{ /* AuthorizationRevocationData */
"username" : "string",
"userId" : "string",
"eiasToken" : "string",
"revokeReason" : "string : [REVOKED_BY_APP, REVOKED_BY_USER, REVOKED_BY_EBAY...]",
"revocationDate" : "string"
}
}
}
FEEDBACK_STAR_RATING
Notification sent when feedback star rating changes.

This notification is sent to a seller or buyer when their feedback start rating has changed.

Delivery
Method
HTTPS webhook (POST)
Retries
3
HTTP headers
  • X-EBAY-SIGNATURE

    ECC message signature.

Types
  • MetaData

    This type specifies the metadata included with the notification.

    topicstring

    This is the unique identifier of the Notification topic.

    schemaVersionstring

    This specifies the version number of the topic schema.

    deprecatedboolean

    This boolean field indicates whether or not the topic is active or deprecated.

  • Notification

    This type includes information about the notification.

    notificationIdstring

    This is the unique identifier of the specific notification.

    eventDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the event that triggered the notification was sent to the recipient.

    publishDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the notification was sent to the recipient.

    publishAttemptCountinteger

    This integer value indicates whether this is the first, second, or third attempt to send the notification to the recipient. When a notification is sent successfully the first time, the integer value returned will be 1.

    dataFeedbackStarRatingData

    This container consists of specific information related to the feedback star rating data.

  • FeedbackStarRatingData

    The base type for the Feedback Star Rating topic notification payload

    userUserFeedbackData

    This container shows the Feedback Star Rating details for the user

  • UserFeedbackData

    This type contains information about the user whose feedback rating has changed.

    userIdstring

    This string is the unique, public identifier for the user whose feedback rating has changed.

    positiveFeedbackPercentnumber

    This number represents the percentage of positive feedback that the user has received based on all feedback entries that user has received as both a buyer and a seller.

    feedbackStarRatingstring

    Below is the list of enums that may be returned in this field to indicate the new Feedback Star Rating that the user has reached.

    Possible Values:
    ValueDescription
    SILVER_SHOOTING_STARA silver shooting feedback star assigned to users with scores in the designated range (1,000,000+ entries).
    GREEN_SHOOTING_STARA green shooting feedback star assigned to users with scores in the designated range (500,000 - 999,999 entries).
    RED_SHOOTING_STARA red shooting feedback star assigned to users with scores in the designated range (100,000 - 499,999 entries).
    PURPLE_SHOOTING_STARA purple shooting feedback star assigned to users with scores in the designated range (50,000 - 99,999 entries).
    TURQUOISE_SHOOTING_STARA turquoise shooting feedback star assigned to users with scores in the designated range (25,000 - 49,999 entries).
    YELLOW_SHOOTING_STARA yellow shooting feedback star assigned to users with scores in the designated range (10,000 - 24,999 entries).
    GREEN_STARA green feedback star assigned to users with scores in the designated range (5,000 - 9,999 entries).
    RED_STARA red feedback star assigned to users with scores in the designated range (1,000 - 4,999 entries).
    PURPLE_STARA purple feedback star assigned to users with scores in the designated range (500 - 999 entries).
    TURQUOISE_STARA turquoise feedback star assigned to users with scores in the designated range (100 - 499 entries).
    BLUE_STARA blue feedback star assigned to users with scores in the designated range (50 - 99 entries).
    YELLOW_STARA yellow feedback star assigned to users with scores in the designated range (10 - 49 entries).
    NONEThere is not enough feedback information to assign a star rating (0 - 9 entries).
Response
{ /* object */
"metadata" :
{ /* MetaData */
"topic" : "string",
"schemaVersion" : "string",
"deprecated" : "boolean"
},
"notification" :
{ /* Notification */
"notificationId" : "string",
"eventDate" : "string",
"publishDate" : "string",
"publishAttemptCount" : "integer",
"data" :
{ /* FeedbackStarRatingData */
"user" :
{ /* UserFeedbackData */
"userId" : "string",
"positiveFeedbackPercent" : "number",
"feedbackStarRating" : "string : [SILVER_SHOOTING_STAR, GREEN_SHOOTING_STAR, RED_SHOOTING_STAR...]"
}
}
}
}
MARKETPLACE_ACCOUNT_DELETION
Notification when a user requests their account be closed.

A subscription for this topic initiates notifications being sent to a developer when an eBay user has requested that their personal data be deleted and their account closed.

For more information, refer to the eBay Marketplace Account Deletion page.

Delivery
Method
HTTPS webhook (POST)
Retries
3
HTTP headers
  • X-EBAY-SIGNATURE

    ECC message signature

Types
  • MetaData

    This type specifies the metadata included with the notification.

    topicstring

    This is the unique identifier of the Notification topic.

    schemaVersionstring

    This specifies the version number of the topic schema.

    deprecatedboolean

    This boolean field indicates whether or not the topic is active or deprecated.

  • Notification

    This type includes information about the notification.

    notificationIdstring

    This is the unique identifier of the specific notification.

    eventDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the event that triggered the notification was sent to the recipient.

    publishDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the notification was sent to the recipient.

    publishAttemptCountinteger

    This integer value indicates whether this is the first, second, or third attempt to send the notification to the recipient. When a notification is sent successfully the first time, the integer value returned will be 1.

    dataMarketplaceAccountDeletionData

    This container consists of specific information related to the marketplace account deletion data.

  • MarketplaceAccountDeletionData

    This type contains the Account Deletion payload.

    usernamestring

    This string is the username for the user.

    Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance.

    userIdstring

    This string is the immutable public userId for the user.

    eiasTokenstring

    This string is the legacy eiasToken specific to the user.

Response
{ /* object */
"metadata" :
{ /* MetaData */
"topic" : "string",
"schemaVersion" : "string",
"deprecated" : "boolean"
},
"notification" :
{ /* Notification */
"notificationId" : "string",
"eventDate" : "string",
"publishDate" : "string",
"publishAttemptCount" : "integer",
"data" :
{ /* MarketplaceAccountDeletionData */
"username" : "string",
"userId" : "string",
"eiasToken" : "string"
}
}
}
SELLER_CUSTOMER_SERVICE_METRIC_RATING
Notification when changes occur in customer service metrics.

This notification is sent to a seller whenever there is a change or projected change to either their Item Not Received and/or Item Not As Described customer service metric(s).

OAuth Scope
In addition to the standard OAuth scope (https://api.ebay.com/oauth/api_scope), this topic requires an access token created using the Authorization Code Grant flow with the following scope:
https://api.ebay.com/oauth/api_scope/sell.analytics.readonly

See Working with OAuth scopes for more information.

Delivery
Method
HTTPS webhook (POST)
Retries
3
HTTP headers
  • X-EBAY-SIGNATURE

    The ECC message signature. This signature is used to process and validate the message payload.

Types
  • Metadata

    This type specifies the metadata included with the notification.

    topicstring

    This is the unique identifier of the Notification topic.

    schemaVersionstring

    This specifies the version number of the topic schema.

    deprecatedboolean

    This boolean field indicates whether or not the topic is active or deprecated.

  • Notification

    This type includes information about the notification.

    notificationIdstring

    This is the unique identifier of the specific notification.

    eventDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the event that triggered the notification was sent to the recipient.

    publishDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the notification was sent to the recipient.

    publishAttemptCountinteger

    This integer value indicates whether this is the first, second, or third attempt to send the notification to the recipient. When a notification is sent successfully the first time, the integer value returned will be 1.

    dataSellerCustomerServiceMetricRatingData

    This container consists of specific information related to the seller customer service metric rating data.

  • SellerCustomerServiceMetricRatingData

    This type defines the payload for the seller customer service metric rating notifications.

    userUser

    This object contains the user details for the notification subscriber.

    cyclestring

    The enum value returned in this field indicates the evaluation cycle used for the customer service metrics, and each enum is described below.

    Possible Values:
    ValueDescription
    CURRENTThis enum value indicates that the seller standards profile metrics are based off of the last official monthly seller standards profile metrics report. The current seller standards profile metrics report is what determines a seller’s current seller level and customer-service ratings.
    PROJECTEDThis enum value indicates that the seller standards profile metrics are indicative of what the seller level and customer-service ratings would be if they were evaluated at this point in time.
    customerServiceMetricstring

    The enum value returned here indicates the customer service metric being evaluated.

    Possible Values:
    ValueDescription
    ITEM_NOT_AS_DESCRIBEDThis value indicates that the customer service metric type being evaluated is Item Not As Described.
    ITEM_NOT_RECEIVEDThis value indicates that the customer service metric type being evaluated is Item Not Received.
    marketPlacesarray of MarketPlace

    This array provides detailed information on the customer service metric being evaluated.

  • User

    This type contains the user details for the notification subscriber.

    userIdstring

    This string is the unique identifier for the user.

    usernamestring

    This string is the username associated with the user.

    Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance.

  • MarketPlace

    This type provides detailed information on the customer service metric being evaluated.

    marketplaceIdstring

    The enum value returned in this field indicates the eBay marketplace where the seller’s customer service metrics are being evaluated..

    Possible Values:
    ValueDescription
    EBAY_ATThis value indicates that the seller’s customer service metrics on the eBay Austria marketplace are being evaulated.
    EBAY_AUThis value indicates that the seller’s customer service metrics on the eBay Australia marketplace are being evaulated.
    EBAY_BEThis value indicates that the seller’s customer service metrics on the eBay Belgium marketplace are being evaulated.
    EBAY_CAThis value indicates that the seller’s customer service metrics on the eBay Canada marketplace are being evaulated.
    EBAY_CHThis value indicates that the seller’s customer service metrics on the eBay Switzerland marketplace are being evaulated.
    EBAY_DEThis value indicates that the seller’s customer service metrics on the eBay Germany marketplace are being evaulated.
    EBAY_ESThis value indicates that the seller’s customer service metrics on the eBay Spain marketplace are being evaulated.
    EBAY_FRThis value indicates that the seller’s customer service metrics on the eBay France marketplace are being evaulated.
    EBAY_GBThis value indicates that the seller’s customer service metrics on the eBay United Kingdom marketplace are being evaulated.
    EBAY_HKThis value indicates that the seller’s customer service metrics on the eBay Hong Kong marketplace are being evaulated.
    EBAY_IEThis value indicates that the seller’s customer service metrics on the eBay Ireland marketplace are being evaulated.
    EBAY_ITThis value indicates that the seller’s customer service metrics on the eBay Italy marketplace are being evaulated.
    EBAY_MYThis value indicates that the seller’s customer service metrics on the eBay Malaysia marketplace are being evaulated.
    EBAY_NLThis value indicates that the seller’s customer service metrics on the eBay Netherlands marketplace are being evaulated.
    EBAY_PHThis value indicates that the seller’s customer service metrics on the eBay Philippines marketplace are being evaulated.
    EBAY_PLThis value indicates that the seller’s customer service metrics on the eBay Poland marketplace are being evaulated.
    EBAY_SGThis value indicates that the seller’s customer service metrics on the eBay Singapore marketplace are being evaulated.
    EBAY_TWThis value indicates that the seller’s customer service metrics on the eBay Taiwan marketplace are being evaulated.
    EBAY_USThis value indicates that the seller’s customer service metrics on the eBay US marketplace are being evaulated.
    EBAY_MOTORS_USThis value indicates that the seller’s customer service metrics on the eBay Moters US marketplace are being evaulated.
    currentCustomerServiceMetric

    This container provides details on customer service metrics if the evaluation cycle is set to CURRENT, which means that these metrics are based on the report from the last evaluation period.

    projectedCustomerServiceMetric

    This container provides details on customer service metrics if the evaluation cycle is set to PROJECTED, which means that these metrics are based on projections from the current evaluation period.

Response
{ /* object */
"metadata" :
{ /* Metadata */
"topic" : "string",
"schemaVersion" : "string",
"deprecated" : "boolean"
},
"notification" :
{ /* Notification */
"notificationId" : "string",
"eventDate" : "string",
"publishDate" : "string",
"publishAttemptCount" : "integer",
"data" :
{ /* SellerCustomerServiceMetricRatingData */
"user" :
{ /* User */
"userId" : "string",
"username" : "string"
},
"cycle" : "string : [CURRENT,PROJECTED]",
"customerServiceMetric" : "string : [ITEM_NOT_AS_DESCRIBED,ITEM_NOT_RECEIVED]",
"marketPlaces" : [
{ /* MarketPlace */
"marketplaceId" : "string : [EBAY_AT, EBAY_AU, EBAY_BE...]",
"current" :
{ /* CustomerServiceMetric */
"evaluationDate" : "string",
"evaluationStartDate" : "string",
"evaluationEndDate" : "string",
"dimensionMetrics" : [
{ /* DimensionMetric */
"dimension" :
{ /* Dimension */
"dimensionKey" : "string : [LISTING_CATEGORY,SHIPPING_REGION]",
"dimensionName" : "string",
"dimensionValue" : "string"
},
"metrics" : [
{ /* Metric */
"metricKey" : "string : [TRANSACTION_COUNT,COUNT,RATE]",
"metricValue" : "string",
"benchmarkBasis" : "string : [PEER_BENCHMARK]",
"benchmarkAdjustment" : "string : [OVERRIDE]",
"benchmarkRating" : "string : [LOW, AVERAGE, HIGH...]",
"benchmarkMetadataAverage" : "string",
"distributions" : [
{ /* MetricDistribution */
"basis" : "string",
"data" : [
{ /* Distribution */
"name" : "string",
"value" : "string"
}
]
}
]
}
]
}
]
},
"projected" :
{ /* CustomerServiceMetric */
"evaluationDate" : "string",
"evaluationStartDate" : "string",
"evaluationEndDate" : "string",
"dimensionMetrics" : [
{ /* DimensionMetric */
"dimension" :
{ /* Dimension */
"dimensionKey" : "string : [LISTING_CATEGORY,SHIPPING_REGION]",
"dimensionName" : "string",
"dimensionValue" : "string"
},
"metrics" : [
{ /* Metric */
"metricKey" : "string : [TRANSACTION_COUNT,COUNT,RATE]",
"metricValue" : "string",
"benchmarkBasis" : "string : [PEER_BENCHMARK]",
"benchmarkAdjustment" : "string : [OVERRIDE]",
"benchmarkRating" : "string : [LOW, AVERAGE, HIGH...]",
"benchmarkMetadataAverage" : "string",
"distributions" : [
{ /* MetricDistribution */
"basis" : "string",
"data" : [
{ /* Distribution */
"name" : "string",
"value" : "string"
}
]
}
]
}
]
}
]
}
}
]
}
}
}
AUCTION_ACTIVITY
Notifications sent when bids are placed on an auction item.

A subscription for this topic initiates auction activity related notifications being sent to bidders and sellers.

The four notifications that may be sent are:

  • BID_PLACED (buyer only)

  • BID_RECEIVED (seller only)

  • OUTBID (buyer only)

  • AUCTION_WON (buyer only)

Delivery
Method
HTTPS webhook (POST)
Retries
3
HTTP headers
  • X-EBAY-SIGNATURE

    The ECC message signature. This signature is used to process and validate the message payload.

Types
  • Metadata

    This type specifies the metadata included with the notification.

    topicstring

    This is the unique identifier of the Notification topic.

    schemaVersionstring

    This specifies the version number of the topic schema.

    deprecatedboolean

    This boolean field indicates whether or not the topic is active or deprecated.

  • Notification

    This type includes information about the notification.

    notificationIdstring

    This is the unique identifier of the specific notification.

    eventDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the event that triggered the notification was sent to the recipient.

    publishDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the notification was sent to the recipient.

    publishAttemptCountinteger

    This integer value indicates whether this is the first, second, or third attempt to send the notification to the recipient. When a notification is sent successfully the first time, the integer value returned will be 1.

    dataPayload

    This container consists of specific information related to the payload for the auction activity events notifications.

  • Payload

    This type is the payload for the Auction Activity notification.

    itemIdstring

    This string is the unique ID associated with the item being auctioned.

    activityAuctionActivity

    This object is the auction activity that has triggered the sending of an AUCTION_ACTIVITY notification.

    sellerUser

    This object is the information about the seller.

    buyerUser

    This object is the information about the buyer who has placed the bid, has been outbid, or has won the auction.

  • AuctionActivity

    Below is the list of enums that may be returned in this field for auction activity that has triggered the sending of an AUCTION_ACTIVITY notification.

    Possible Values:
    ValueDescription
    BID_PLACEDThis indicates the buyer’s bid has been submitted on an auction-style listing.
    BID_RECEIVEDThis inidcates the seller’s listing has received a new bid from a buyer.
    OUTBIDThis indicates the buyer’s previous highest bid has been surpassed by another bidder.
    AUCTION_WONThis indicates the buyer’s bid is highest at auction end and wins the item.
  • User

    This type represents the information about the subscribed user.

    userIdstring

    This string is the unique, public identifier for the subscribed user.

    userNamestring

    This string is the username associated with the subscribed user.

    Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance.

Response
{ /* object */
"metadata" :
{ /* Metadata */
"topic" : "string",
"schemaVersion" : "string",
"deprecated" : "boolean"
},
"notification" :
{ /* Notification */
"notificationId" : "string",
"eventDate" : "string",
"publishDate" : "string",
"publishAttemptCount" : "integer",
"data" :
{ /* Payload */
"itemId" : "string",
"activity" : "AuctionActivity : [BID_PLACED, BID_RECEIVED, OUTBID...]",
"seller" :
{ /* User */
"userId" : "string",
"userName" : "string"
},
"buyer" :
{ /* User */
"userId" : "string",
"userName" : "string"
}
}
}
}
AUCTION_ENDED
Notification sent to buyers and sellers when an auction ends.

A subscription for this topic initiates a notification being sent to buyers and sellers as soon as an auction listing ends, with or without a winning bidder.

Delivery
Method
HTTPS webhook (POST)
Retries
3
HTTP headers
  • X-EBAY-SIGNATURE

    The ECC message signature. This signature is used to process and validate the message payload.

Types
  • Metadata

    This type specifies the metadata included with the notification.

    topicstring

    This is the unique identifier of the Notification topic.

    schemaVersionstring

    This specifies the version number of the topic schema.

    deprecatedboolean

    This boolean field indicates whether or not the topic is active or deprecated.

  • Notification

    This type includes information about the notification.

    notificationIdstring

    This is the unique identifier of the specific notification.

    eventDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the event that triggered the notification was sent to the recipient.

    publishDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the notification was sent to the recipient.

    publishAttemptCountinteger

    This integer value indicates whether this is the first, second, or third attempt to send the notification to the recipient. When a notification is sent successfully the first time, the integer value returned will be 1.

    dataPayload

    This container consists of specific information related to the payload for the auction ended events notifications.

  • Payload

    This type is the payload for the Auction Ended notification.

    itemIdstring

    This string is the unique identifier of the item for which the Auction Ended notification is being sent.

    sellerUser

    This string is the user information for the seller of the item for which the Auction Ended notification is being sent.

  • User

    This type is the user information for the subscribed recipient of the Auction Ended notification.

    userIdstring

    This string is the unique public identifier for the subscribed recipient of the Auction Ended notification.

    userNamestring

    This string is the username associated with the subscribed recipient of the Auction Ended notification.

    Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance.

Response
{ /* object */
"metadata" :
{ /* Metadata */
"topic" : "string",
"schemaVersion" : "string",
"deprecated" : "boolean"
},
"notification" :
{ /* Notification */
"notificationId" : "string",
"eventDate" : "string",
"publishDate" : "string",
"publishAttemptCount" : "integer",
"data" :
{ /* Payload */
"itemId" : "string",
"seller" :
{ /* User */
"userId" : "string",
"userName" : "string"
}
}
}
}
Order Management

Order Management-related notifications applicable for buyers and sellers

ITEM_MARKED_SHIPPED
This notification can be sent to a buyer or seller when an item is marked as shipped by eBay or by the seller.

This notification includes the shipping carrier, the tracking number of the shipment, the order ID, and the line item ID.

OAuth Scope
In addition to the standard OAuth scope (https://api.ebay.com/oauth/api_scope), this topic requires an access token created using the Authorization Code Grant flow with the following scope:
https://api.ebay.com/oauth/api_scope/commerce.shipping

See Working with OAuth scopes for more information.

Delivery
Method
HTTPS webhook (POST)
Retries
3
HTTP headers
  • X-EBAY-SIGNATURE

    ECC message signature header used to verify the payload.

Types
  • MetaData

    This type specifies the metadata included with the notification.

    topicstring

    This is the unique identifier of the Notification topic.

    schemaVersionstring

    This specifies the version number of the topic schema.

    deprecatedboolean

    This boolean field indicates whether or not the topic is active or deprecated.

  • Notification

    This type includes information about the notification.

    notificationIdstring

    This is the unique identifier of the specific notification.

    eventDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the event that triggered the notification was sent to the recipient.

    publishDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the notification was sent to the recipient.

    publishAttemptCountinteger

    This integer value indicates whether this is the first, second, or third attempt to send the notification to the recipient. When a notification is sent successfully the first time, the integer value returned will be 1.

    dataItemMarkedShippedData

    This container consists of specific information related to the item marked shipped data.

  • ItemMarkedShippedData

    This type defines the payload for the ITEM_MARKED_SHIPPED event.

    trackingNumberstring

    This string is the shipment tracking number.

    carrierstring

    This string is the shipping carrier (e.g., USPS, UPS, FedEx).

    shippedDatestring

    This timestamp indicates when the item was marked as shipped.

    orderIdstring

    The unique identifier of the order associated with the shipment.

    itemIdstring

    The unique identifier of the listing associated with the shipment.

    transactionIdstring

    The unique identifier of the transaction associated with the shipment.

    lineItemIdstring

    The unique identifier of the order line item associated with the shipment.

    publicUserIdstring

    This string is the immutable user identifier associated with the seller.

    usernamestring

    The seller's username.

    Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance. .

Response
{ /* object */
"metadata" :
{ /* MetaData */
"topic" : "string",
"schemaVersion" : "string",
"deprecated" : "boolean"
},
"notification" :
{ /* Notification */
"notificationId" : "string",
"eventDate" : "string",
"publishDate" : "string",
"publishAttemptCount" : "integer",
"data" :
{ /* ItemMarkedShippedData */
"trackingNumber" : "string",
"carrier" : "string",
"shippedDate" : "string",
"orderId" : "string",
"itemId" : "string",
"transactionId" : "string",
"lineItemId" : "string",
"publicUserId" : "string",
"username" : "string"
}
}
}
BUYER_REQUESTED_PURCHASE_QUOTE
This notification is sent to a seller if the buyer is requesting an invoice.

This notification is sent to a seller if a buyer has requested an invoice with updated price totals for an unpaid item commitment/transaction. The notification payload includes the listing ID, the item commitment ID, and the total quantity.

Delivery
Method
HTTPS webhook (POST)
Retries
3
HTTP headers
  • X-EBAY-SIGNATURE

    The ECC message signature. This signature is used to process and validate the message payload.

Types
  • MetaData

    This type specifies the metadata included with the notification.

    topicstring

    This is the unique identifier of the Notification topic.

    schemaVersionstring

    This specifies the version number of the topic schema.

    deprecatedboolean

    This boolean field indicates whether or not the topic is active or deprecated.

  • Notification

    This type includes information about the notification.

    notificationIdstring

    This is the unique identifier of the specific notification.

    eventDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the event that triggered the notification was sent to the recipient.

    publishDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the notification was sent to the recipient.

    publishAttemptCountinteger

    This integer value indicates whether this is the first, second, or third attempt to send the notification to the recipient. When a notification is sent successfully the first time, the integer value returned will be 1.

    dataBuyerRequestedPurchaseQuoteData

    This container consists of specific information related to requested purchase quote data from the buyer.

  • BuyerRequestedPurchaseQuoteData

    This type defines the payload for the Buyer Requested Purchase Quote notification.

    userUser

    The seller user details for the notification subscriber.

    purchaseQuoteIdstring

    The unique identifier for the purchase quote.

    itemCommitmentsarray of ItemCommitment

    This array is a list of one or more item commitments associated with the purchase quote.

  • User

    The user details for the notification subscriber.

    userIdstring

    The public user identifier

    usernamestring

    The public user name

  • ItemCommitment

    This type provides the item commitment details associated with the purchase quote.

    listingIdstring

    This string is the unique identifier for the listing.

    itemCommitmentIdstring

    This string is the unique identifier for the item commitment.

    quantityinteger

    This integer is the quantity for this item commitment.

Response
{ /* object */
"metadata" :
{ /* MetaData */
"topic" : "string",
"schemaVersion" : "string",
"deprecated" : "boolean"
},
"notification" :
{ /* Notification */
"notificationId" : "string",
"eventDate" : "string",
"publishDate" : "string",
"publishAttemptCount" : "integer",
"data" :
{ /* BuyerRequestedPurchaseQuoteData */
"user" :
{ /* User */
"userId" : "string",
"username" : "string"
},
"purchaseQuoteId" : "string",
"itemCommitments" : [
{ /* ItemCommitment */
"listingId" : "string",
"itemCommitmentId" : "string",
"quantity" : "integer"
}
]
}
}
}
ORDER_CONFIRMATION
Notification sent to seller when buyer completes checkout.

This notification is sent to a seller when the buyer completes the checkout process and payment clears for a fixed price or auction listing.

OAuth Scope
In addition to the standard OAuth scope (https://api.ebay.com/oauth/api_scope), this topic requires an access token created using the Authorization Code Grant flow with the following scopes:
https://api.ebay.com/oauth/api_scope/sell.fulfillment,
https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly

See Working with OAuth scopes for more information.

Delivery
Method
HTTPS webhook (POST)
Retries
3
HTTP headers
  • X-EBAY-SIGNATURE

    The ECC message signature. This signature is used to process and validate the message payload.

Types
  • MetaData

    This type specifies the metadata included with the notification.

    topicstring

    This is the unique identifier of the Notification topic.

    schemaVersionstring

    This specifies the version number of the topic schema.

    deprecatedboolean

    This boolean field indicates whether or not the topic is active or deprecated.

  • Notification

    This type includes information about the notification.

    notificationIdstring

    This is the unique identifier of the specific notification.

    eventDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the event that triggered the notification was sent to the recipient.

    publishDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the notification was sent to the recipient.

    publishAttemptCountinteger

    This integer value indicates whether this is the first, second, or third attempt to send the notification to the recipient. When a notification is sent successfully the first time, the integer value returned will be 1.

    dataOrderConfirmationData

    This container consists of specific information related to the order confirmation data.

  • OrderConfirmationData

    This type defines the payload for the Order Confirmation notification.

    userUser

    The seller details for the notification subscriber.

    orderOrder

    This object contains the order details for the notification subscriber.

  • User

    The user details for the notification subscriber.

    userIdstring

    The public user identifier

    usernamestring

    The public username

  • Order

    This type contains the order details for the notification subscriber.

    orderIdstring

    This string is the unique identifier for the order.

    orderLineItemsarray of OrderLineItem

    This array contains the order line item information for the order.

Response
{ /* object */
"metadata" :
{ /* MetaData */
"topic" : "string",
"schemaVersion" : "string",
"deprecated" : "boolean"
},
"notification" :
{ /* Notification */
"notificationId" : "string",
"eventDate" : "string",
"publishDate" : "string",
"publishAttemptCount" : "integer",
"data" :
{ /* OrderConfirmationData */
"user" :
{ /* User */
"userId" : "string",
"username" : "string"
},
"order" :
{ /* Order */
"orderId" : "string",
"orderLineItems" : [
{ /* OrderLineItem */
"orderLineItemId" : "string",
"listingId" : "string",
"quantity" : "integer"
}
]
}
}
}
}
Offers and Leads

Offers and Leads-related notifications applicable for buyers and sellers

OFFER_ACTIVITY
Notifications sent to buyer or seller when listing offer activity occurs.

A subscription for this topic initiates offer-related notifications being sent to a buyer or seller when listing offer activity occurs.

The four notifications that may be sent are:

  • BUYER_OFFER (seller only)

  • BUYER_COUNTER_OFFER (seller only)

  • SELLER_OFFER (buyer only)

  • SELLER_COUNTER_OFFER (buyer only).

Delivery
Method
HTTPS webhook (POST)
Retries
3
HTTP headers
  • X-EBAY-SIGNATURE

    The ECC message signature. This signature is used to process and validate the message payload.

Types
  • Metadata

    This type specifies the metadata included with the notification.

    topicstring

    This is the unique identifier of the Notification topic.

    schemaVersionstring

    This specifies the version number of the topic schema.

    deprecatedboolean

    This boolean field indicates whether or not the topic is active or deprecated.

  • Notification

    This type includes information about the notification.

    notificationIdstring

    This is the unique identifier of the specific notification.

    eventDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the event that triggered the notification was sent to the recipient.

    publishDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the notification was sent to the recipient.

    publishAttemptCountinteger

    This integer value indicates whether this is the first, second, or third attempt to send the notification to the recipient. When a notification is sent successfully the first time, the integer value returned will be 1.

    dataPayload

    This container consists of specific information related to the payload for the offer events.

  • Payload

    This type is the payload for best offer events.

    offerIdstring

    This string is the unique ID for the offer record.

    itemIdstring

    This string indicates the item on which the offer activity took place.

    statusOfferStatus

    This object represents the current state of the offer in its lifecycle

    offerTypeOfferType

    This object references the type of the offer based on the current negotiation status. It indicates if the offer was sent by the seller or the buyer and if this was an initial or counter offer.

    sellerUser

    This object represents the seller.

    buyerUser

    This object represents the buyer who placed the offer.

  • OfferStatus

    Below is the list of enums that may be returned in this field to indicate the current status of the offer.

    Possible Values:
    ValueDescription
    PENDINGThe offer is awaiting a response from the buyer.
    DECLINEDThe buyer has declined the seller's offer.
    ACCEPTEDThe buyer has accepted the offer that was sent by the seller.
    EXPIREDThe offer reached its deadline and is no longer available to the buyer.
  • OfferType

    Below is the list of enums that may be returned in this field to describe the offer based on the current negotiation status. It also indicate who sent this offer and whether this was an initial offer or a counter offer.

    Possible Values:
    ValueDescription
    BUYER_OFFERThis is the offer initiated by the buyer on a listing, pending seller response.
    BUYER_COUNTER_OFFERThis is a buyer’s revised offer in response to a previous seller offer..
    SELLER_OFFERThis is a seller-initiated offer to sell the item to the buyer at a specified price.
    SELLER_COUNTER_OFFERThis is a seller's revised offer in response to a previous buyer offer.
Response
{ /* */
"metadata" :
{ /* Metadata */
"topic" : "string",
"schemaVersion" : "string",
"deprecated" : "boolean"
},
"notification" :
{ /* Notification */
"notificationId" : "string",
"eventDate" : "string",
"publishDate" : "string",
"publishAttemptCount" : "integer",
"data" :
{ /* Payload */
"offerId" : "string",
"itemId" : "string",
"status" : "OfferStatus : [PENDING, DECLINED, ACCEPTED...]",
"offerType" : "OfferType : [BUYER_OFFER, BUYER_COUNTER_OFFER, SELLER_OFFER...]",
"seller" :
{ /* User */
"userId" : "string",
"userName" : "string"
},
"buyer" :
{ /* User */
"userId" : "string",
"userName" : "string"
}
}
}
}
Communication

Communication-related notifications applicable for buyers and sellers

BUYER_QUESTION
This notification is sent to a seller when a buyer asks a question about the seller’s listing.

Use this event to receive a notification when a potential buyer/bidder asks a question on an active listing.

OAuth Scope
In addition to the standard OAuth scope (https://api.ebay.com/oauth/api_scope), this topic requires an access token created using the Authorization Code Grant flow with the following scope:
https://api.ebay.com/oauth/api_scope/commerce.message

See Working with OAuth scopes for more information.

Delivery
Method
HTTPS webhook (POST)
Retries
3
HTTP headers
  • X-EBAY-SIGNATURE

    The ECC message signature. This signature is used to process and validate the message payload.

Types
  • MetaData

    This type specifies the metadata included with the notification.

    topicstring

    This is the unique identifier of the Notification topic.

    schemaVersionstring

    This specifies the version number of the topic schema.

    deprecatedboolean

    This boolean field indicates whether or not the topic is active or deprecated.

  • Notification

    This type includes information about the notification.

    notificationIdstring

    This is the unique identifier of the specific notification.

    eventDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the event that triggered the notification was sent to the recipient.

    publishDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the notification was sent to the recipient.

    publishAttemptCountinteger

    This integer value indicates whether this is the first, second, or third attempt to send the notification to the recipient. When a notification is sent successfully the first time, the integer value returned will be 1.

    dataBuyerQuestionData

    This container consists of specific information related to the buyer question data.

  • BuyerQuestionData

    This type defines the payload for the BUYER_QUESTION notification.

    messageIdstring

    This string is the unique identifier of the message.

    conversationIdstring

    This string is the unique identifier of the conversation.

    messageBodystring

    This string is the body text of the message.

    listingIdstring

    This string is the unique identifier of the listing associated with the conversation.

    senderUserNamestring

    This string is the eBay username of the sender.

    Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance.

    recipientUserNamestring

    This string is the eBay username of the recipient.

    Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance.

    subjectstring

    This string is the subject of the message.

    readStatusboolean

    This Boolean indicates if the message has been read.

    createdDatestring

    This timestamp indicates when the message was created, in ISO 8601 format.

    messageMediaarray of object

    This array is a list of media attachments associated with a message.

Response
{ /* object */
"metadata" :
{ /* MetaData */
"topic" : "string",
"schemaVersion" : "string",
"deprecated" : "boolean"
},
"notification" :
{ /* Notification */
"notificationId" : "string",
"eventDate" : "string",
"publishDate" : "string",
"publishAttemptCount" : "integer",
"data" :
{ /* BuyerQuestionData */
"messageId" : "string",
"conversationId" : "string",
"messageBody" : "string",
"listingId" : "string",
"senderUserName" : "string",
"recipientUserName" : "string",
"subject" : "string",
"readStatus" : "boolean",
"createdDate" : "string",
"messageMedia" : "object[]"
}
}
}
FEEDBACK_LEFT
This notification is sent to a buyer or seller when their feedback for their order partner has been recorded by eBay.

This notification is sent to a seller or buyer when the feedback they have left for their order partner for a line item has been recorded.

Delivery
Method
HTTPS webhook (POST)
Retries
3
HTTP headers
  • X-EBAY-SIGNATURE

    ECC message signature

Types
  • MetaData

    This type specifies the metadata included with the notification.

    topicstring

    This is the unique identifier of the Notification topic.

    schemaVersionstring

    This specifies the version number of the topic schema.

    deprecatedboolean

    This boolean field indicates whether or not the topic is active or deprecated.

  • Notification

    This type includes information about the notification.

    notificationIdstring

    This is the unique identifier of the specific notification.

    eventDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the event that triggered the notification was sent to the recipient.

    publishDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the notification was sent to the recipient.

    publishAttemptCountinteger

    This integer value indicates whether this is the first, second, or third attempt to send the notification to the recipient. When a notification is sent successfully the first time, the integer value returned will be 1.

    dataFeedbackData

    This container consists of specific information related to the feedback data.

  • FeedbackData

    This type defines the payload for the Feedback Left notification.

    receiverUserDetailReceiverUserDetail

    This object contains the information about the user who received the feedback.

    feedbackDetailFeedbackDetail

    This type includes the details of the feedback left by the user.

    commentTypestring

    Below is the list of enums that may be returned in this field for the type of feedback being received. When leaving feedback, only a buyer can use these ratings for a seller. A seller can only leave a buyer Positive feedback.

    Possible Values:
    ValueDescription
    POSITIVEThis value indicates that the feedback expresses satisfaction with the transaction or experience. This typically reflects a successful and favorable interaction between the buyer and seller.
    NEUTRALThis value indicates that the feedback is neither distinctly favorable nor unfavorable. The transaction was completed, but did not fully meet expectations, or was considered average.
    NEGATIVEThis value indicates dissatisfaction with the transaction or experience. This type of feedback highlights issues or problems that occurred, signaling that the buyer or seller was not satisfied.
    feedbackCommentFeedbackComment

    This object contains the feedback comment left by the user.

    replyCommentReplyComment

    This object contains the feedback reply comment.

    followupCommentFollowupComment

    This object contains the feedback follow-up comment.

    providerUserDetailProviderUserDetail

    This object contains information about the user who provided the feedback.

    feedbackStatestring

    Below is the list of enums that may be returned in this field for the state of the entire feedback as a whole.

    Possible Values:
    ValueDescription
    ENTEREDThis value indicates that the feedback has been submitted and is currently active. The feedback is visible to applicable parties.
    DESCOREDThis value indicates that the feedback has a score impact of 0 and does not contribute to the overall feedback score.
    MUTUAL_WITHDRAWAL_INITIATEDThis value indicates that the buyer or seller has started a mutual feedback withdrawal process and agreement from the other party is pending.
    FEEDBACK_REVISION_OPENThis value indicates that a feedback revision request has been sent and is currently open and awaiting a response.
    FEEDBACK_REVISION_CLOSEDThis value indicates tha tthe feedback revision request has been closed either because the request was revised, declined, or it expired.
    feedbackEnteredDatestring

    This string is the date when the feedback was entered. This date is returned as a UTC-formatted timestamp.

  • ReceiverUserDetail

    This object contains the information about the user who received the feedback.

    userIdstring

    This string is the unique, public identifier for the user who received the feedback.

    rolestring

    Below is the list of enums that may be returned in this field for the role of the user who provided the feedback.

    Possible Values:
    ValueDescription
    BUYERThis value indicates that the receiver of the feedback is a buyer.
    SELLERThis value indicates that the receiver of the feedback is a seller.
  • ListingPrice

    The price information of the item for which feedback has been left.

    currencystring

    The currency used for the price of the item..

    valuenumber

    The price of the item.

Response
{ /* object */
"metadata" :
{ /* MetaData */
"topic" : "string",
"schemaVersion" : "string",
"deprecated" : "boolean"
},
"notification" :
{ /* Notification */
"notificationId" : "string",
"eventDate" : "string",
"publishDate" : "string",
"publishAttemptCount" : "integer",
"data" :
{ /* FeedbackData */
"receiverUserDetail" :
{ /* object */
"userId" : "string",
"role" : "string : [BUYER,SELLER]"
},
"feedbackDetail" :
{ /* object */
"feedbackId" : "string",
"orderLineItemSummary" :
{ /* object */
"orderLineItemId" : "string",
"listingId" : "string",
"listingTitle" : "string",
"listingPrice" :
{ /* object */
"currency" : "string",
"value" : "number"
}
}
},
"commentType" : "string : [POSITIVE,NEUTRAL,NEGATIVE]",
"feedbackComment" :
{ /* object */
"commentText" : "string",
"state" : "string : [ENTERED, WITHDRAWN, HIDDEN...]"
},
"replyComment" :
{ /* object */
"commentText" : "string",
"state" : "string : [ENTERED, WITHDRAWN, HIDDEN...]"
},
"followupComment" :
{ /* object */
"commentText" : "string",
"state" : "string : [ENTERED, WITHDRAWN, HIDDEN...]"
},
"providerUserDetail" :
{ /* object */
"userId" : "string",
"role" : "string : [BUYER,SELLER]",
"feedbackScore" : "integer"
},
"feedbackState" : "string : [ENTERED, DESCORED, MUTUAL_WITHDRAWAL_INITIATED...]",
"feedbackEnteredDate" : "string"
}
}
}
FEEDBACK_RECEIVED
This notification is sent to a buyer or seller when their order partner has left feedback for them.

This notification is sent to a seller or buyer when their order partner has left them feedback for a line item.

Delivery
Method
HTTPS webhook (POST)
Retries
3
HTTP headers
  • X-EBAY-SIGNATURE

    ECC message signature

Types
  • MetaData

    This type specifies the metadata included with the notification.

    topicstring

    This is the unique identifier of the Notification topic.

    schemaVersionstring

    This specifies the version number of the topic schema.

    deprecatedboolean

    This boolean field indicates whether or not the topic is active or deprecated.

  • Notification

    This type includes information about the notification.

    notificationIdstring

    This is the unique identifier of the specific notification.

    eventDatestring

    publishDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the notification was sent to the recipient.

    publishAttemptCountinteger

    This integer value indicates whether this is the first, second, or third attempt to send the notification to the recipient. When a notification is sent successfully the first time, the integer value returned will be 1.

    dataFeedbackData

    This container consists of specific information related to the feedback data.

  • FeedbackData

    This type is the payload for the Feedback Received notification.

    receiverUserDetailReceiverUserDetail

    This object contains the information about the user who received the feedback.

    feedbackDetailFeedbackDetail

    This object contains the details of the feedback received by the user.

    commentTypestring

    Below is the list of enums that may be returned in this field to indicate the type of feedback being received. When leaving feedback, only a buyer can use these ratings for a seller. A seller can only leave a buyer Positive feedback.

    Possible Values:
    ValueDescription
    POSITIVEThis value indicates that the feedback expresses satisfaction with the transaction or experience. This typically reflects a successful and favorable interaction between the buyer and seller.
    NEUTRALThis value indicates that the feedback is neither distinctly favorable nor unfavorable. The transaction was completed, but did not fully meet expectations, or was considered average.
    NEGATIVEThis value indicates dissatisfaction with the transaction or experience. This type of feedback highlights issues or problems that occurred, signaling that the buyer or seller was not satisfied.
    feedbackCommentFeedbackComment

    This object contains the feedback comment received by the user.

    replyCommentReplyComment

    This object contains the feedback reply comment.

    followupCommentFollowupComment

    This object contains the feedback follow up comment.

    providerUserDetailProviderUserDetail

    This object contains information about the user who provided the feedback.

    feedbackStatestring

    Below is the list of enums that may be returned in this field as the possible state of the entire feedback as a whole.

    Possible Values:
    ValueDescription
    ENTEREDThis value indicates that the feedback has been submitted and is currently active. The feedback is visible to applicable parties.
    DESCOREDThis value indicates that the feedback has a score impact of 0 and does not contribute to the overall feedback score.
    MUTUAL_WITHDRAWAL_INITIATEDThis value indicates that the buyer or seller has started a mutual feedback withdrawal process and agreement from the other party is pending.
    FEEDBACK_REVISION_OPENThis value indicates that a feedback revision request has been sent and is currently open and awaiting a response.
    FEEDBACK_REVISION_CLOSEDThis value indicates tha tthe feedback revision request has been closed either because the request was revised, declined, or it expired.
    feedbackEnteredDatestring

    This string is the date when the feedback was entered. This date is returned as a UTC-formatted timestamp.

  • ReceiverUserDetail

    This object contains the information about the user who received the feedback.

    userIdstring

    This string is the unique, public identifier for the user who received the feedback.

    rolestring

    Below is the list of enums that may be returned in this field as the role of the user who provided the feedback.

    Possible Values:
    ValueDescription
    BUYERThis value indicates that the receiver of the feedback is a buyer.
    SELLERThis value indicates that the receiver of the feedback is a seller.
  • ListingPrice

    This object contains the price information of the item for which feedback has been received.

    currencystring

    This string indicates the currency used for the price of the item.

    valuenumber

    The price of the item.

Response
{ /* object */
"metadata" :
{ /* MetaData */
"topic" : "string",
"schemaVersion" : "string",
"deprecated" : "boolean"
},
"notification" :
{ /* Notification */
"notificationId" : "string",
"eventDate" : "string",
"publishDate" : "string",
"publishAttemptCount" : "integer",
"data" :
{ /* FeedbackData */
"receiverUserDetail" :
{ /* object */
"userId" : "string",
"role" : "string : [BUYER,SELLER]"
},
"feedbackDetail" :
{ /* object */
"feedbackId" : "string",
"orderLineItemSummary" :
{ /* object */
"orderLineItemId" : "string",
"listingId" : "string",
"listingTitle" : "string",
"listingPrice" :
{ /* object */
"currency" : "string",
"value" : "number"
}
}
},
"commentType" : "string : [POSITIVE,NEUTRAL,NEGATIVE]",
"feedbackComment" :
{ /* object */
"commentText" : "string",
"state" : "string : [ENTERED, WITHDRAWN, HIDDEN...]"
},
"replyComment" :
{ /* object */
"commentText" : "string",
"state" : "string : [ENTERED, WITHDRAWN, HIDDEN...]"
},
"followupComment" :
{ /* object */
"commentText" : "string",
"state" : "string : [ENTERED, WITHDRAWN, HIDDEN...]"
},
"providerUserDetail" :
{ /* object */
"userId" : "string",
"role" : "string : [BUYER,SELLER]",
"feedbackScore" : "integer"
},
"feedbackState" : "string : [ENTERED, DESCORED, MUTUAL_WITHDRAWAL_INITIATED...]",
"feedbackEnteredDate" : "string"
}
}
}
NEW_MESSAGE
Notification when a user receives a new message.

Sellers or buyers subscribed to this topic will get a notification each time another member or eBay sends them a new message that starts or continues a conversation.

OAuth Scope
In addition to the standard OAuth scope (https://api.ebay.com/oauth/api_scope), this topic requires an access token created using the Authorization Code Grant flow with the following scope:
https://api.ebay.com/oauth/api_scope/commerce.message

See Working with OAuth scopes for more information.

Delivery
Method
HTTPS webhook (POST)
Retries
3
HTTP headers
  • X-EBAY-SIGNATURE

    The ECC message signature. This signature is used to process and validate the message payload.

Types
  • MetaData

    This type specifies the metadata included with the notification.

    topicstring

    This is the unique identifier of the Notification topic.

    schemaVersionstring

    This specifies the version number of the topic schema.

    deprecatedboolean

    This boolean field indicates whether or not the topic is active or deprecated.

  • Notification

    This type includes information about the notification.

    notificationIdstring

    This is the unique identifier of the specific notification.

    eventDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the event that triggered the notification was sent to the recipient.

    publishDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the notification was sent to the recipient.

    publishAttemptCountinteger

    This integer value indicates whether this is the first, second, or third attempt to send the notification to the recipient. When a notification is sent successfully the first time, the integer value returned will be 1.

    dataNewMessageData

    This container consists of specific information related to the new message data.

  • NewMessageData

    This type defines the payload for the NEW_MESSAGE notification.

    messageIdstring

    This string is the unique identifier of the message.

    conversationTypestring

    The enum value in this field indicates if the new message is from another eBay user or from eBay.

    Possible Values:
    ValueDescription
    FROM_MEMBERSThis value indicates the message is being sent by an eBay member.
    FROM_EBAYThis value indicates the message is being sent from eBay.
    conversationIdstring

    This string is the unique identifier of the conversation.

    messageBodystring

    This string is the body text of the message.

    senderUserNamestring

    This string represents the eBay username of the sender.

    Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance.

    recipientUserNamestring

    This string represents the eBay username of the recipient.

    Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance.

    subjectstring

    This string is the subject of the message.

    readStatusboolean

    This Boolean Indicates if the message has been read.

    createdDatestring

    This timestamp indicates when the message was created, in ISO 8601 format.

    messageMediaarray of object

    This array is a list of media attachments associated with a message.

Response
{ /* object */
"metadata" :
{ /* MetaData */
"topic" : "string",
"schemaVersion" : "string",
"deprecated" : "boolean"
},
"notification" :
{ /* Notification */
"notificationId" : "string",
"eventDate" : "string",
"publishDate" : "string",
"publishAttemptCount" : "integer",
"data" :
{ /* NewMessageData */
"messageId" : "string",
"conversationType" : "string : [FROM_MEMBERS,FROM_EBAY]",
"conversationId" : "string",
"messageBody" : "string",
"senderUserName" : "string",
"recipientUserName" : "string",
"subject" : "string",
"readStatus" : "boolean",
"createdDate" : "string",
"messageMedia" : "object[]"
}
}
}
Marketing and Promotions

Promoted Listing or Item Discount notifications for sellers

PLA_CAMPAIGN_BUDGET_STATUS
Sent when a Promoted Listings priority strategy campaign budget is exhausted.

A subscription for this topic initiates notifications being sent to sellers when their Promoted Listings priority strategy ad campaign (formerly Promoted Listings Advanced (PLA)) daily budget has been completely exhausted.

OAuth Scope
In addition to the standard OAuth scope (https://api.ebay.com/oauth/api_scope), this topic requires an access token created using the Authorization Code Grant flow with the following scopes:
https://api.ebay.com/oauth/api_scope/sell.marketing,
https://api.ebay.com/oauth/api_scope/sell.marketing.readonly

See Working with OAuth scopes for more information.

Delivery
Method
HTTPS webhook (POST)
Retries
3
HTTP headers
  • X-EBAY-SIGNATURE

    The ECC message signature. This signature is used to process and validate the message payload.

Types
  • Metadata

    This type specifies the metadata included with the notification.

    topicstring

    This is the unique identifier of the Notification topic.

    schemaVersionstring

    This specifies the version number of the topic schema.

    deprecatedboolean

    This boolean field indicates whether or not the topic is active or deprecated.

  • Notification

    This type includes information about the notification.

    notificationIdstring

    This is the unique identifier of the specific notification.

    eventDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the event that triggered the notification was sent to the recipient.

    publishDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the notification was sent to the recipient.

    publishAttemptCountinteger

    This integer value indicates whether this is the first, second, or third attempt to send the notification to the recipient. When a notification is sent successfully the first time, the integer value returned will be 1.

    dataPLACampaignBudgetStatusData

    This container consists of specific information related to the PLA campaign budget status data.

  • PLACampaignBudgetStatusData

    This type defines the payload for the PLA campaign budget status notification.

    userUser

    This object contains the information about the user that is the notification subscriber.

    campaignIdstring

    This string is the unique identifier for the PLA campaign that has an exhausted daily budget.

    budgetStatusstring

    The enum value returned in this field indicates the status of the daily budget for the PLA campaign.

    Possible Values:
    ValueDescription
    OUT_OF_BUDGETThis value indicates that the daily budget for the campaign has been exhausted.
  • User

    This type is the user details for the notification subscriber.

    userIdstring

    This string is the unique identifier for the user.

    usernamestring

    This string is the username of the seller.

    Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance.

Response
{ /* object */
"metadata" :
{ /* Metadata */
"topic" : "string",
"schemaVersion" : "string",
"deprecated" : "boolean"
},
"notification" :
{ /* Notification */
"notificationId" : "string",
"eventDate" : "string",
"publishDate" : "string",
"publishAttemptCount" : "integer",
"data" :
{ /* PLACampaignBudgetStatusData */
"user" :
{ /* User */
"userId" : "string",
"username" : "string"
},
"campaignId" : "string",
"budgetStatus" : "string : [OUT_OF_BUDGET]"
}
}
}
Inventory Discovery and Refresh

Buyer-facing notifications concerning inventory discovery and listing revisions

ITEM_PRICE_REVISION
This notification is sent to eBay Partner Network partners when an item's price changes.

This notification is sent to an eBay Partner Network partners when a listing’s Buy it Now price and/or the minimum bid price changes for an auction listing.

Note: Currently, this topic is available for eBay Partner Network (ePN) partners in all marketplaces except the following: CA, AU, HK, SG, MY, and PH.

Delivery
Method
HTTPS webhook (POST)
Retries
3
HTTP headers
  • X-EBAY-SIGNATURE

    ECC message signature

Types
  • MetaData

    This type specifies the metadata included with the notification.

    topicstring

    This is the unique identifier of the Notification topic.

    schemaVersionstring

    This specifies the version number of the topic schema.

    deprecatedboolean

    This boolean field indicates whether or not the topic is active or deprecated.

  • Notification

    This type includes information about the notification.

    notificationIdstring

    This is the unique identifier of the specific notification.

    eventDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the event that triggered the notification was sent to the recipient.

    publishDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the notification was sent to the recipient.

    publishAttemptCountinteger

    This integer value indicates whether this is the first, second, or third attempt to send the notification to the recipient. When a notification is sent successfully the first time, the integer value returned will be 1.

    dataItemPriceRevisionData

    This container consists of specific information related to the item price revision data.

  • ItemPriceRevisionData

    This type defines the Item Price Revision payload.

    itemIdstring

    The unique identifier of a purchasable item.

    listingMarketplaceIdstring

    Below is the list of enums that may be returned in this field and indicate the standard codes that represent each of the eBay marketplaces.

    Possible Values:
    ValueDescription
    EBAY_USeBay US (ebay.com)
    EBAY_GBeBay UK (ebay.co.uk)
    EBAY_AUeBay Australia (ebay.com/au)
    EBAY_ATeBay Austria (ebay.at)
    EBAY_FReBay France (ebay.fr)
    EBAY_DEeBay Germany (ebay.de)
    EBAY_ITeBay Italy (ebay.it)
    EBAY_BEeBay Belgium (ebay.com/sch/Belgium)
    EBAY_NLeBay Netherlands (ebay.nl)
    EBAY_ESeBay Spain (ebay.es)
    EBAY_CHeBay Switzerland (ebay.ch)
    EBAY_HKeBay Hong Kong (ebay.com.hk)
    EBAY_IEeBay Ireland (ebay.ie)
    EBAY_MYeBay Malaysia (ebay.com/my)
    EBAY_CAeBay Canada (English) (ebay.ca)
    EBAY_PHeBay Philippines (ebay.ph)
    EBAY_PLeBay Poland (ebay.pl)
    EBAY_SGeBay Singapore (ebay.com/sg)
    sellerSeller

    This object contains the information of the seller.

    pricePrice

    This object contains the pricing information of the item.

    minimumBidPriceMinimumBidPrice

    This object contains information on the minimum bid placed on the item.

    buyingOptionsstring

    Below is the list of enums that may be returned in this field that defines the buyer options for the item.

    Possible Values:
    ValueDescription
    AUCTIONThis enumeration value indicates that the line item is available for purchase through an auction listing by being the highest bidder at auction end.
    FIXED_PRICEThis enumeration value indicates that the line item is available for purchase through a fixed price listing or through an auction listing with the ‘Buy it Now’ feature enabled.
    BEST_OFFERThis enumeration value indicates that the line item is available for purchase through the Best Offer process if Best Offer is enabled on a fixed price listing or an auction listing.
    categoryIdstring

    The unique identifier of the primary listing category.

    metaCategoryIdstring

    The unique identifier of the primary listing category’s parent category.

    categoryNamestring

    The canonical name of the primary (leaf) category.

    categoryPathstring

    The full path to the primary (leaf) category.

  • Seller

    This object contains the information of the seller.

    usernamestring

    This string is the username of the seller.

    Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance.

  • Price

    This object contains the pricing information of the item.

    currencystring

    Below is the list of enums that may be returned in this field that include the three-letter ISO 4217 code representing the supported world currencies.

    Possible Values:
    ValueDescription
    AEDUnited Arab Emirates dirham
    AFNAfghan afghani
    ALLAlbanian lek
    AMDArmenian dram
    AOAAngolan kwanza
    ARSArgentine peso
    AWGAruban florin
    AZNAzerbaijani manat
    BAMBosnia and Herzegovina convertible mark
    BBDBarbados dollar
    BDTBangladeshi taka
    BGNBulgarian lev
    BHDBahraini dinar
    BIFBurundian franc
    BMDBermudian dollar
    BNDBrunei dollar
    BOBBolivian Boliviano
    BRLBrazilian real
    BSDBahamian dollar
    BTNBhutanese ngultrum
    BWPBotswana pula
    BYRBelarusian ruble
    BZDBelize dollar
    CADCanadian dollar
    CDFCongolese franc
    CLPChilean peso
    CNYChinese yuan renminbi
    COPColombian peso
    CRCCosta Rican colon
    CUPCuban peso
    CVECape Verde escudo
    CZKCzech koruna
    DJFDjiboutian franc
    DOPDominican peso
    DZDAlgerian dinar
    EGPEgyptian pound
    ERNEritrean nakfa
    ETBEthiopian birr
    FJDFiji dollar
    FKPFalkland Islands pound
    GELGeorgian lari
    GHSGhanaian cedi
    GIPGibraltar pound
    DKKDanish krone
    GMDGambian dalasi
    GNFGuinean franc
    GTQGuatemalan quetzal
    GYDGuyanese dollar
    HKDHong Kong dollar
    HNLHonduran lempira
    HRKCroatian kuna
    HTGHaitian gourde
    HUFHungarian forint
    IDRIndonesian rupiah
    INRIndian rupee
    IQDIraqi dinar
    IRRIranian rial
    ISKIcelandic krona
    GBPBritish pound sterling
    JMDJamaican dollar
    JODJordanian dinar
    JPYJapanese yen
    KESKenyan shilling
    KGSKyrgyzstani som
    KHRCambodian riel
    KMFComoro franc
    KPWNorth Korean won
    KRWSouth Korean won
    KWDKuwaiti dinar
    KYDCayman Islands dollar
    KZTKazakhstani tenge
    LAKLao kip
    LBPLebanese pound
    CHFSwiss franc
    LKRSri Lankan rupee
    LRDLiberian dollar
    LSLLesotho loti
    LTLLithuanian litas
    LYDLibyan dinar
    MADMoroccan dirham
    MDLMoldovan leu
    MGAMalagasy ariary
    MKDMacedonian denar
    MMKMyanmar kyat
    MNTMongolian tugrik
    MOPMacanese pataca
    MROMauritanian ouguiya
    XCDEast Caribbean dollar
    MURMauritian rupee
    MVRMaldivian rufiyaa
    MWKMalawian kwacha
    MXNMexican peso
    MYRMalaysian ringgit
    MZNMozambican metical
    NADNamibian dollar
    NGNNigerian naira
    NIONicaraguan cordoba oro
    NPRNepalese rupee
    OMROmani rial
    PABPanamanian balboa
    PENPeruvian sol
    XPFCFP franc
    PGKPapua New Guinean kina
    PHPPhilippine peso
    PKRPakistani rupee
    PLNPolish zloty
    ILSIsraeli new shekel
    PYGParaguayan guarani
    QARQatari riyal
    RONRomanian leu
    RSDSerbian dinar
    RUBRussian ruble
    RWFRwandan franc
    SARSaudi riyal
    SBDSolomon Islands dollar
    SCRSeychelles rupee
    SDGSudanese pound
    SEKSwedish krona
    SGDSingapore dollar
    SHPSaint Helena pound
    NOKNorwegian krone
    SLLSierra Leonean leone
    SOSSomali shilling
    SRDSurinamese dollar
    STDSao Tome and Principe dobra
    ANGNetherlands Antillean guilder
    SYPSyrian pound
    SZLSwazi lilangeni
    XAFCFA franc BEAC
    XOFCFA franc BCEAO
    THBThai baht
    TJSTajikistani somoni
    NZDNew Zealand dollar
    TMTTurkmenistani manat
    TNDTunisian dinar
    TOPTongan pa'anga
    TRYTurkish lira
    TTDTrinidad and Tobago dollar
    AUDAustralian dollar
    TWDNew Taiwan dollar
    TZSTanzanian shilling
    UAHUkrainian hryvnia
    UGXUgandan shilling
    USDUnited States dollar
    UYUUruguayan peso
    UZSUzbekistani som
    VEFVenezuelan bolivar
    VNDVietnamese dong
    VUVVanuatu vatu
    WSTSamoan tala
    YERYemeni rial
    EUREuropean Union euro
    ZARSouth African rand
    ZMWZambian kwacha
    ZWLZimbabwean dollar
    valuestring

    The price of the item.

Response
{ /* object */
"metadata" :
{ /* MetaData */
"topic" : "string",
"schemaVersion" : "string",
"deprecated" : "boolean"
},
"notification" :
{ /* Notification */
"notificationId" : "string",
"eventDate" : "string",
"publishDate" : "string",
"publishAttemptCount" : "integer",
"data" :
{ /* ItemPriceRevisionData */
"itemId" : "string",
"listingMarketplaceId" : "string : [EBAY_US, EBAY_GB, EBAY_AU...]",
"seller" :
{ /* object */
"username" : "string"
},
"price" :
{ /* object */
"currency" : "string : [AED, AFN, ALL...]",
"value" : "string"
},
"minimumBidPrice" :
{ /* object */
"currency" : "string : [AED, AFN, ALL...]",
"value" : "string"
},
"buyingOptions" : "string : [AUCTION,FIXED_PRICE,BEST_OFFER]",
"categoryId" : "string",
"metaCategoryId" : "string",
"categoryName" : "string",
"categoryPath" : "string"
}
}
}
PRIORITY_LISTING_REVISION
This notification is sent to eBay Partner Network partners when an item has been added to or removed from a Promoted Listing Priority campaign.

A subscription for this topic initiates notifications being sent to sellers and buyers when a Priority Listing has been revised.

Note: Currently, this topic is available for eBay Partner Network (ePN) partners in all marketplaces except the following: CA, AU, HK, SG, MY, and PH.

Delivery
Method
HTTPS webhook (POST)
Retries
3
HTTP headers
  • X-EBAY-SIGNATURE

    ECC message signature

Types
  • MetaData

    This type specifies the metadata included with the notification.

    topicstring

    This is the unique identifier of the Notification topic.

    schemaVersionstring

    This specifies the version number of the topic schema.

    deprecatedboolean

    This boolean field indicates whether or not the topic is active or deprecated.

  • Notification

    This type includes information about the notification.

    notificationIdstring

    This is the unique identifier of the specific notification.

    eventDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the event that triggered the notification was sent to the recipient.

    publishDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the notification was sent to the recipient.

    publishAttemptCountinteger

    This integer value indicates whether this is the first, second, or third attempt to send the notification to the recipient. When a notification is sent successfully the first time, the integer value returned will be 1.

    dataPriorityListingRevisionData

    This container consists of specific information related to the priority listing revision data.

  • PriorityListingRevisionData

    This type defines the Priority Listing Revision payload.

    itemIdstring

    The unique identifier of the purchasable item.

    primaryItemGroupIdstring

    The unique identifier of the item group that the item belongs to. This field is only returned if the purchasable item is variation within a multiple-variation listing.

    listingMarketplaceIdstring

    Below is the list of enums that may be returned in this field that represent the standard codes for each of the eBay marketplaces.

    Possible Values:
    ValueDescription
    EBAY_USeBay US (ebay.com)
    EBAY_GBeBay UK (ebay.co.uk)
    EBAY_AUeBay Australia (ebay.com/au)
    EBAY_ATeBay Austria (ebay.at)
    EBAY_FReBay France (ebay.fr)
    EBAY_DEeBay Germany (ebay.de)
    EBAY_ITeBay Italy (ebay.it)
    EBAY_BEeBay Belgium (ebay.com/sch/Belgium)
    EBAY_NLeBay Netherlands (ebay.nl)
    EBAY_ESeBay Spain (ebay.es)
    EBAY_CHeBay Switzerland (ebay.ch)
    EBAY_HKeBay Hong Kong (ebay.com.hk)
    EBAY_IEeBay Ireland (ebay.ie)
    EBAY_MYeBay Malaysia (ebay.com/my)
    EBAY_CAeBay Canada (English) (ebay.ca)
    EBAY_PHeBay Philippines (ebay.ph)
    EBAY_PLeBay Poland (ebay.pl)
    EBAY_SGeBay Singapore (ebay.com/sg)
    sellerSeller

    This object contains the information of the seller.

    categoryIdstring

    The unique identifier of the primary listing category.

    metaCategoryIdstring

    The unique identifier of the primary listing category’s parent category.

    priorityListingboolean

    Thos Boolean indicates if the purchasable item is a part of a Promoted Listing Priority campaign.

  • Seller

    This object contains the information of the seller.

    userNamestring

    This string is the username of the seller.

    Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance.

    userIdstring

    This string is the userId of the seller.

Response
{ /* object */
"metadata" :
{ /* MetaData */
"topic" : "string",
"schemaVersion" : "string",
"deprecated" : "boolean"
},
"notification" :
{ /* Notification */
"notificationId" : "string",
"eventDate" : "string",
"publishDate" : "string",
"publishAttemptCount" : "integer",
"data" :
{ /* PriorityListingRevisionData */
"itemId" : "string",
"primaryItemGroupId" : "string",
"listingMarketplaceId" : "string : [EBAY_US, EBAY_GB, EBAY_AU...]",
"seller" :
{ /* object */
"userName" : "string",
"userId" : "string"
},
"categoryId" : "string",
"metaCategoryId" : "string",
"priorityListing" : "boolean"
}
}
}
ITEM_AVAILABILITY
Sent when a fixed-price item’s availability type changes.

A subscription for this topic initiates notifications being sent to a developer when a fixed-price item's availability type changes.

Supported availability types are:

  • AVAILABLE
  • UNAVAILABLE
  • TEMPORARILY_UNAVAILABLE

Note: Currently, this topic is available for eBay Partner Network (ePN) partners in all marketplaces except the following: CA, AU, HK, SG, MY, and PH.

Delivery
Method
HTTPS webhook (POST)
Retries
3
HTTP headers
  • X-EBAY-SIGNATURE

    ECC message signature

Types
  • MetaData

    This type specifies the metadata included with the notification.

    topicstring

    This is the unique identifier of the Notification topic.

    schemaVersionstring

    This specifies the version number of the topic schema.

    deprecatedboolean

    This boolean field indicates whether or not the topic is active or deprecated.

  • Notification

    This type includes information about the notification.

    notificationIdstring

    This is the unique identifier of the specific notification.

    eventDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the event that triggered the notification was sent to the recipient.

    publishDatestring

    This is the timestamp that indicates the date and time (in UTC format) when the notification was sent to the recipient.

    publishAttemptCountinteger

    This integer value indicates whether this is the first, second, or third attempt to send the notification to the recipient. When a notification is sent successfully the first time, the integer value returned will be 1.

    dataItemAvailabilityData

    This container consists of specific information related to the item availability data.

  • ItemAvailabilityData

    This type encompasses the Item Availability payload.

    itemIdstring

    This is the ID for the item.

    listingMarketplaceIdstring

    This enumeration type is used to indicate the eBay marketplace where the item is listed.

    Possible Values:
    ValueDescription
    EBAY_USThis value indicates that the listing is on the eBay US marketplace.
    EBAY_GBThis value indicates that the listing is on the eBay UK marketplace.
    EBAY_AUThis value indicates that the listing is on the eBay Australia marketplace.
    EBAY_ATThis value indicates that the listing is on the eBay Austria marketplace.
    EBAY_FRThis value indicates that the listing is on the eBay France marketplace.
    EBAY_DEThis value indicates that the listing is on the eBay Germany marketplace.
    EBAY_ITThis value indicates that the listing is on the eBay Italy marketplace
    EBAY_BEThis value indicates that the listing is on the eBay Belgium marketplace.
    EBAY_NLThis value indicates that the listing is on the eBay Netherlands marketplace.
    EBAY_ESThis value indicates that the listing is on the eBay Spain marketplace.
    EBAY_CHThis value indicates that the listing is on the eBay Switzerland marketplace.
    EBAY_HKThis value indicates that the listing is on the eBay Hong Kong marketplace.
    EBAY_IEThis value indicates that the listing is on the eBay Ireland marketplace.
    EBAY_MYThis value indicates that the listing is on the eBay Malaysia marketplace.
    EBAY_CAThis value indicates that the listing is on the eBay Canada marketplace.
    EBAY_PHThis value indicates that the listing is on the eBay Philippines marketplace.
    EBAY_PLThis value indicates that the listing is on the eBay Poland marketplace.
    EBAY_SGThis value indicates that the listing is on the eBay Singapore marketplace.
    buyingOptionsarray

    This array shows the list of the purchase options available to the buyer to purchase the item.

    Possible Values:
    ValueDescription
    FIXED_PRICEThis value indicates that the item can be directly purchased through a fixed price listing.
    AUCTIONThis value indicates that the buyer can win the item through an auction listing by being the highest bidder at the end of the auction.
    BEST_OFFERThis value indicates that the buyer can propose a Best Offer to the seller for the item.
    sellerSeller

    This object includes the seller information.

    categoryIdstring

    The unique identifier of the eBay primary (leaf) category.

    metaCategoryIdstring

    The unique identifier of the parent category of the leaf category defined in the categoryId field.

    categoryNamestring

    The canonical name of the primary (leaf) category.

    categoryPathstring

    The full path to the primary (leaf) category

    availabilitystring

    The enum returned here indicates the current availability of the item.

    Possible Values:
    ValueDescription
    TEMPORARILY_UNAVAILABLEThis value indicates that the item can’t be purchased through the listing at the moment, which could be due to the seller having their account set to vacation mode or the item being out of stock.
    AVAILABLEThis value indicates that the item is available for purchase through the listing.
    UNAVAILABLEThis value indicates that the item is no longer available and isn’t expected to be available any longer under that listing ID due to listing being ended.
  • Seller

    This object includes the seller information.

    usernamestring

    This string is the username of the seller.

    Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance.

Response
{ /* object */
"metadata" :
{ /* MetaData */
"topic" : "string",
"schemaVersion" : "string",
"deprecated" : "boolean"
},
"notification" :
{ /* Notification */
"notificationId" : "string",
"eventDate" : "string",
"publishDate" : "string",
"publishAttemptCount" : "integer",
"data" :
{ /* ItemAvailabilityData */
"itemId" : "string",
"listingMarketplaceId" : "string : [EBAY_US, EBAY_GB, EBAY_AU...]",
"buyingOptions" : "array : [FIXED_PRICE,AUCTION,BEST_OFFER]",
"seller" :
{ /* Seller */
"username" : "string"
},
"categoryId" : "string",
"metaCategoryId" : "string",
"categoryName" : "string",
"categoryPath" : "string",
"availability" : "string : [TEMPORARILY_UNAVAILABLE,AVAILABLE,UNAVAILABLE]"
}
}
}