We have updated our APIs to address requirements for third-party developers based in certain jurisdictions. Among those impacted are API users in China (and its territories), Russia, North Korea, Cuba, Iran, and Venezuela.
Username Replacement for U.S. Buyers and Sellers
Effective September 26, 2025, developers in affected marketplaces will no longer receive private username data for U.S users. Instead, username values for all U.S. buyers and sellers will be replaced with an immutable user ID when calling impacted APIs.
This includes:
-
API responses: All API responses that give out username in one form or another, such as: payer, payee, login name, username, etc.
-
Notification payloads: All notification payloads that return username in one form or another, such as: payer, payee, login name, username, etc.
Note: In API and notification payloads where both username and userId are returned, users in affected regions will now see the userId value returned in both the fields.
In addition, impacted APIs will now support both username and userID values in the request body, parameters, fieldgroups, filters, etc. to support this change.
Please refer to the tables below for a list of all APIs and fields impacted by this update:
Traditional APIs:
Rest APIs:
API Family | Request/Response | API Name | API Endpoint | Fields |
---|---|---|---|---|
Sell | Request | eDelivery International Shipping | createPackage | buyerId |
getPackage | ||||
Response | Fulfillment | getOrder | ||
sellerId | ||||
getOrders | username | |||
sellerId | ||||
getPaymentDispute | buyerUsername | |||
getPaymentDisputeSummaries | buyerUsername | |||
Finance | getTransactions | username | ||
Identity | getUser | username | ||
Negotiation | sendOfferToInterestedBuyers | maskedUsername | ||
PostOrder Returns | getReturn | buyerLoginName | ||
sellerLoginName | ||||
searchReturns | buyerLoginName | |||
sellerLoginName | ||||
createReturn | buyerLoginName | |||
sellerLoginName | ||||
PostOrder Cancellation | getCancelDetail | buyerLoginName | ||
sellerLoginName | ||||
findCancel | buyerLoginName | |||
sellerLoginName | ||||
PostOrder Inquiry | searchInquiries | buyer | ||
seller | ||||
PostOrder Case Management | searchCases | buyer | ||
seller | ||||
Buy | Response | Browse | search | username |
searchByImage | username | |||
getItem | username | |||
getItemByLegacyId | username | |||
getItems | username | |||
getItemsByItemGroup | username | |||
Identity | getUser | username |
Notifications:
Notification Type | Topic Name | API Payload | Fields |
---|---|---|---|
Notifications via the new Notification Platform | PLA_CAMPAIGN_BUDGET_STATUS | N/A | user.username |
PRIORITY_LISTING_REVISION | N/A | seller.userName | |
MARKETPLACE_ACCOUNT_DELETION | N/A | username | |
AUTHORIZATION_REVOCATION | N/A | username | |
ITEM_AVAILABILITY | N/A | seller.username | |
ITEM_PRICE_REVISION | N/A | seller.username | |
SELLER_STANDARDS_PROFILE_METRICS | N/A | user.username | |
SELLER_CUSTOMER_SERVICE_METRIC_RATING | N/A | user.username | |
LISTING_PREVIEW_CREATION_TASK_STATUS | N/A | user.username | |
Legacy Notifications | Outbid | GetItem | N/A |
EndOfAuction | GetItemTransactions | N/A | |
AuctionCheckoutComplete | GetItemTransactions | N/A | |
CheckoutBuyerRequestsTotal | GetItemTransactions | N/A | |
FeedbackForSeller | GetFeedback | N/A | |
FixedPriceTransaction | GetItemTransactions | N/A | |
AskSellerQuestion | GetMemberMessages | N/A | |
ItemListed | GetItem | N/A | |
BestOffer | GetBestOffers | N/A | |
ItemRevised | GetItem | N/A | |
MyMessageseBayMessageHeader | GetMyMessages | N/A | |
MyMessagseeBayMessage | GetMyMessages | N/A | |
MyMessagesM2MMessageHeader | GetMyMessages | N/A | |
MyMessagesM2MMessage | GetMyMessages | N/A | |
ItemSold | GetItem | N/A | |
ItemClosed | GetItem | N/A | |
ItemExtended | GetItem | N/A | |
BidPlaced | GetItem | N/A | |
BidReceived | GetItem | N/A | |
ItemWon | GetItem | N/A | |
ItemUnsold | GetItem | N/A | |
FeedbackLeft | GetFeedback | N/A | |
FeedbackStarChanged | GetUser | N/A | |
BestOfferPlaced | GetBestOffers | N/A | |
CounterOfferRecieved | GetBestOffers | N/A | |
BestOfferDeclined | GetBestOffers | N/A | |
FeedbackReceived | GetFeedback | N/A | |
ItemMarkedShipped | GetItemTransactions | N/A | |
MyMessagesHighPriorityMessage | GetMyMessages | N/A | |
MyMessagesHighPriorityMessageHeader | GetMyMessages | N/A | |
BidItemEndingSoon | GetItem | N/A | |
Post Order Notifications | EBPMyResponseDue | N/A | RecipientUserID |
N/A | OtherPartyId | ||
EBPOtherPartyResponseDue | N/A | RecipientUserID | |
N/A | OtherPartyId | ||
EBPEscalatedCase | N/A | RecipientUserID | |
N/A | OtherPartyId | ||
EBPAppealedCase | N/A | RecipientUserID | |
N/A | OtherPartyId | ||
EBPPaymentDone | N/A | RecipientUserID | |
N/A | OtherPartyId | ||
EBPClosedCase | N/A | RecipientUserID | |
N/A | OtherPartyId | ||
EBPOnHoldCase | N/A | RecipientUserID | |
N/A | OtherPartyId | ||
ReturnCreated | N/A | RecipientUserID | |
N/A | OtherPartyId | ||
ReturnSellerInfoOverdue | N/A | RecipientUserID | |
N/A | OtherPartyId | ||
ReturnShipped | N/A | RecipientUserID | |
N/A | OtherPartyId | ||
ReturnDelivered | N/A | RecipientUserID | |
N/A | OtherPartyId | ||
ReturnRefundOverdue | N/A | RecipientUserID | |
N/A | OtherPartyId | ||
ReturnEscalated | N/A | RecipientUserID | |
N/A | OtherPartyId | ||
ReturnClosed | N/A | RecipientUserID | |
N/A | OtherPartyId | ||
WebnextMobilePhotoSync | N/A | RecipientUserID | |
BuyerCancelRequested | N/A | RecipientUserID | |
N/A | OtherPartyId | ||
OrderInquiryReminderForEscalation | N/A | RecipientUserID | |
N/A | OtherPartyId |
Note: Feed files downloaded through the Sell Feed API will also be impacted by this change.
Financial Data Handling for U.S. Buyers
Effective September 26, 2025, access to financial data related to U.S. buyers' payment methods and payment instruments will be limited to select developers only. For all other developers, any response field returning a U.S buyer’s payment details will have its values replaced with “CustomCode”.
Note: The data for non-US persons will continue to be returned without change.
Please refer to the tables below for a list of all APIs and fields impacted by this update:
Traditional APIs:
Request/Response | API Name | API Endpoint | Field |
---|---|---|---|
Response | Trading API | GetOrders | OrderArray.Order.CheckoutStatus.PaymentInstrument |
OrderArray.Order.CheckoutStatus.PaymentMethod | |||
OrderArray.Order.PaymentMethods | |||
OrderArray.Order.TransactionArray.Transaction.Status.PaymentInstrument | |||
GetItemTransactions | TransactionArray.Transaction.Status.PaymentInstrument | ||
TransactionArray.Transaction.Status.PaymentMethodUsed | |||
TransactionArray.Transaction.Status.PaymentInstrument | |||
GetSellerTransactions | TransactionArray.Transaction.Status.PaymentMethodUsed |
REST APIs:
API Family | Request/Response | API Name | API Endpoint | Fields |
---|---|---|---|---|
Sell | Response | Fulfillment | getOrder | paymentMethod |
getOrders | paymentMethod | |||
Feed | Order task download | PaymentInstrument | ||
PaymentMethod |
Notifications:
Notification Type | Topic Name | API Payload | Fields |
---|---|---|---|
Legacy Notifications | FixedPriceTransaction | GetItemTransactions | TransactionArray.Transaction.Status.PaymentInstrument |
TransactionArray.Transaction.Status.PaymentMethodUsed | |||
AuctionCheckoutComplete | GetItemTransactions | TransactionArray.Transaction.Status.PaymentInstrument | |
TransactionArray.Transaction.Status.PaymentMethodUsed | |||
EndOfAuction | GetItemTransactions | TransactionArray.Transaction.Status.PaymentInstrument | |
TransactionArray.Transaction.Status.PaymentMethodUsed | |||
CheckoutBuyerRequestsTotal | GetItemTransactions | TransactionArray.Transaction.Status.PaymentInstrument | |
TransactionArray.Transaction.Status.PaymentMethodUsed | |||
ItemMarkedShipped | GetItemTransactions | TransactionArray.Transaction.Status.PaymentInstrument | |
TransactionArray.Transaction.Status.PaymentMethodUsed |
Note: Feed files downloaded through the Sell Feed API will also be impacted by this change.
Implementation Timeline
These changes will be effective from September 26, 2025, for applications from the countries listed above.