Conversation
BREAKING CHANGE: Removed methods getAlsoBoughtByProduct, getAlsoViewedByProduct from buy marketing API and suppressViolation from sell compliance API. Removed corresponding types AddCartItemInput, RemoveCartItemInput, UpdateCartItemInput, SuppressViolationRequest. These operations were deprecated by eBay and no longer available in updated API specs. # Conflicts: # specs/sell_fulfillment_v1_oas3.json
- Keep next-10 (v10.0.0-RC.0) as authoritative for API source files and generated specs - Incorporate master's dependency updates (eslint, rollup 4, newer packages, overrides) - Merge CHANGELOG: v10 RC entry + full v9.4.x history from master - Merge README: v10 version table + master's developer account link - Resolve .gitignore: keep both CLAUDE.md and .claude entries - Keep buy_order_v1_beta_oas3.ts deleted (intentional in v10) - Retain fetch-openapi script from next-10 alongside updated gen-openapi
BREAKING CHANGE: The Buy Order API migrated to v2, which only exposes the guest checkout flow. Removed the member checkout session, proxy-guest checkout session, payment-info, initiate-payment and place-order operations and their request types (CreateSignInCheckoutSessionRequest, GuestPlaceOrderRequest, InitiatePaymentRequest, UpdatePaymentInformation, CheckoutSessionRequestWithoutPayment). These endpoints no longer exist in the eBay Order v2 API.
# Conflicts: # CHANGELOG.md # README.md # package-lock.json # package.json
BREAKING CHANGE: Removes the 29 methods eBay decommissioned across the post-order return, case, inquiry and cancellation APIs, and prunes the matching operations from the custom specs. Ported from the closed PR #214.
Adds sell account v2 combined-shipping-rules and user-preferences methods (account v2 spec bumped to v2.2.0), sell finances order-earnings and billing-activity methods, and sell metadata shipping lookup methods. Adds PATCH support to the Restful base client and IEBayApiRequest to back setUserPreferences. Ported from the closed PR #214.
eBay now serves the OpenAPI specs behind Akamai Bot Manager, so a bare https.get 403s on every URL. Send a browser User-Agent, keep a cookie jar, and retry once with the issued bot-mitigation cookies (bm_ss/bm_s/bm_so). Verified 26/26 active specs return 200. Comment out sell/account/v2 (static contract has a dangling $ref that omits SetUserPreferencesRequest) and sell/compliance (no longer published, 302); both APIs are kept with manually-maintained specs.
Refreshes the RESTful OpenAPI specs to eBay's current published versions (e.g. sell finances v1.17.3->v1.19.0, metadata v1.11.1->v1.12.1, marketing v1.22.2->v1.23.2, inventory v1.18.4->v1.18.5) and regenerates all TypeScript types. Repoints redocly.yaml at buy_order_v2. Reconciles the client with the refreshed specs: - commerce media: add uploadPostOrderDocument, downloadPostOrderDocument and removePostOrderDocument; uploadVideo body typed as any (InputStream schema removed upstream) - sell account v1: add bulkCreateOrReplaceSalesTax - sell marketing: remove setupQuickCampaign (quick_setup operation retired) BREAKING CHANGE: Removed sell marketing setupQuickCampaign and the QuickSetupRequest type, and the commerce media InputStream type; all were removed from eBay's updated specs.
- commerce media: send multipart/form-data (via multipartHeader) for createImageFromFile, uploadDocument and uploadPostOrderDocument; eBay rejects these uploads under the default application/json content type - commerce media: download post-order documents as arraybuffer so the binary PDF response is not corrupted by JSON decoding - sell finances: comma-join getTransactions filter when given an array, since the params serializer would otherwise emit repeated filter params that eBay does not interpret as combined criteria
jostrander
reviewed
Jul 21, 2026
Comment on lines
+1
to
+2
| // Note: SuppressViolationRequest removed in updated Compliance API | ||
| // import {SuppressViolationRequest} from '../../../../types/index.js'; |
Contributor
There was a problem hiding this comment.
@dantio I can't find evidence this API still exists aside from the spec still being available. The docs have dropped it.
Collaborator
Author
There was a problem hiding this comment.
Good catch — confirmed. eBay decommissioned the Sell Compliance API and all its methods on 2026-03-30 (the developer docs and the published OpenAPI spec were both removed). I've now removed the entire Compliance API — client, spec, generated types, and all factory/registry wiring — in b4686f0. eBay.sell.compliance is gone. Thanks for flagging it!
BREAKING CHANGE: eBay decommissioned the Sell Compliance API and all its methods on 2026-03-30 (developer docs and the published OpenAPI spec were removed). Removes the Compliance API client (getListingViolations, getListingViolationsSummary), its spec JSON and generated types, and all factory/registry wiring. eBay.sell.compliance is no longer available.
# Conflicts: # CHANGELOG.md # README.md # package-lock.json # package.json
jostrander
reviewed
Jul 22, 2026
jostrander
left a comment
jostrander
left a comment
Contributor
There was a problem hiding this comment.
Looks like the new sell_stores_v1 API could be added potentially as well. The spec download is a POST or I'd recommend adding it to the downloader.
Comment on lines
+62
to
+63
| | **Finding API** | ✔ | | ||
| | **Shopping API** | ✔ | |
Contributor
There was a problem hiding this comment.
Collaborator
Author
There was a problem hiding this comment.
Yes — done in e7f1625. I removed the entire traditional Finding API (client, call definitions, types, factory/registry wiring, the README examples and the example script). eBay.finding is gone. Per eBay's deprecation-status page the Finding API was taken down server-side in Feb 2025, so this resolves #199.
While I was in the README I also cleaned up the stale Compliance API rows that were still lingering in these tables (and in the package.json keywords) after b4686f0. Thanks for flagging it! 🙏
Adds the eBay Sell Stores API (sell/stores/v1) with all 8 operations: getStore, getStoreCategories, addStoreCategory, renameStoreCategory, deleteStoreCategory, moveStoreCategory, getStoreTask and getStoreTasks. Wires the spec into redocly.yaml + the fetch-openapi downloader, generates types, and registers the client on eBay.sell.stores. Requested in PR #216 review by @jostrander.
eBay took down the traditional Finding API server-side in February 2025 (see the API deprecation-status page); requests now return errors. Removes the Finding client, its call definitions, types, factory/registry wiring, README examples and the example script. eBay.finding is no longer available. Also drops the now-stale Compliance API references from the README tables and package.json keywords (the Compliance API was removed in b4686f0). Resolves #199. Flagged in PR #216 review by @jostrander. BREAKING CHANGE: eBay.finding has been removed. The eBay Finding API was decommissioned by eBay in February 2025. Migrate item search to the Buy Browse API (eBay.buy.browse).
Collaborator
Author
|
@jostrander good call on the Stores API — added in 2a6deab. Turns out the spec downloads fine over a plain GET ( The client is now exposed on |
jostrander
approved these changes
Jul 23, 2026
jostrander
left a comment
jostrander
left a comment
Contributor
There was a problem hiding this comment.
The breaking changes should probably be updated, but otherwise it looks good
| * `v10.0.0-RC.1` is the latest release. | ||
| * See [here](https://github.com/hendt/ebay-api/blob/master/CHANGELOG.md) for the full changelog. | ||
|
|
||
| ## Implementation status |
Contributor
There was a problem hiding this comment.
Is this duplicated from line 46?
Collaborator
Author
There was a problem hiding this comment.
Good eye — yes, it was. There was an entire duplicated ## Changelog + ## Implementation status block here, and the copy carried stale version numbers (e.g. Browse v1.10.0 / Order v1_beta.20.0 vs the current v1.20.2 / v2.1.2 above). Removed the duplicate and kept the up-to-date table in 9613316. Thanks!
Adds a "Migrating from v9 to v10" section documenting the breaking changes (removed Finding and Compliance APIs, Buy Order v1->v2 migration, pruned Buy/Sell Marketing and post-order methods, Commerce Media InputStream) with migration guidance, plus a TOC entry. Also removes an accidentally duplicated "## Changelog" + "## Implementation status" block that carried stale version numbers, and bumps the surviving changelog line to v10.0.0-RC.1. Flagged in PR #216 review by @jostrander.
Collaborator
Author
|
Thanks for the approval! 🙏 Re: breaking changes — I've added a Migrating from v9 to v10 section to the README in 9613316 that documents them with migration guidance:
The CHANGELOG breaking-change entries themselves are captured in the |
Collaborator
Author
|
@jostrander 10.0.0-RC.2 released |
Contributor
|
So far it looks good @dantio, thanks for the updates, the readme still says rc.1 just FYI |
enrichRequestConfig spread defaultApiHeaders *after* the per-request config.headers, so the hardcoded 'Content-Type: application/json' always won. Every endpoint that sets its own content type was silently sending JSON instead, and eBay rejected the upload: createImageFromFile, uploadDocument, uploadPostOrderDocument (commerce media), uploadFile (sell feed) and uploadEvidenceFile (sell fulfillment). The multipart headers added in 45bf087 never reached the wire. Headers now merge least- to most-specific: library defaults, then the marketplace/locale headers, then auth, then the app-level apiConfig headers, then the per-request headers, and finally the signature headers (which are derived from the final request and must win). Fixes two endpoints that were missed when the binary content types were first corrected: * commerce media uploadVideo now sends 'application/octet-stream' as its spec requires, and takes an optional third `headers` argument so Content-Range/Content-Length can be supplied for resumable uploads. * sell logistics downloadLabelFile now requests 'application/pdf' with responseType 'arraybuffer' instead of trying to parse a PDF as JSON. A DELETE body lives in config.data, so it never reached the digital signature payload and no 'content-digest' header was emitted for it. Restful.delete now mirrors config.data onto the request. Also adds the missing encodeURIComponent to the sell logistics path parameters. BREAKING CHANGE: a per-request Content-Type now overrides one set globally via apiConfig.headers. Previously the global value won.
The spec refresh in 7459bf8 removed these operations from eBay's own published OpenAPI documents, but the client classes kept implementing them. They pointed at endpoints eBay no longer serves, and oas.spec.ts could not catch them because it only walked spec -> implementation. Removed (verified operation-by-operation against the base and head specs): * buy browse: getShoppingCart (the /shopping_cart resource is gone; its addItem/removeItem/updateQuantity siblings were removed earlier) * buy feed: getProductFeed (the /product feed is gone) * commerce catalog: getChangeRequest, getChangeRequests, getProductMetadata, getProductMetadataForCategories * commerce charity: getCharityOrgByLegacyId * sell account v1: getInventoryLocation, getInventoryLocations, createInventoryLocation, updateInventoryLocation, deleteInventoryLocation, enableInventoryLocation, disableInventoryLocation and getSalesTaxJurisdictions * sell marketing: launchCampaign * sell metadata: getProductAdoptionPolicies The sell account location methods were duplicates targeting /sell/account/v1/location, a path eBay does not serve. The working implementations of all seven live on eBay.sell.inventory and are unaffected. Also drops the 15 post-order request types left behind when their methods were pruned in cb1af3f, and deletes two examples that called removed methods. oas.spec.ts now asserts the reverse direction too: every public method an API class declares must correspond to an operationId in its spec. A future spec refresh that drops an operation now fails the suite. BREAKING CHANGE: 17 methods that eBay has decommissioned were removed, along with the BuyerCloseCaseRequest, BuyerCloseInquiryRequest, CheckEligibilityRequest, CheckInquiryEligibilityRequest, CloseReturnRequest, ConfirmRefundRequest, CreateInquiryRequest, GetEstimateRequest, MarkAsShippedRequest, MarkRefundSentRequest, ReturnAddressRequest, SellerProvideRefundInfoRequest, SetReturnCreationSessionRequest, UpdateTrackingRequest and VoidLabelRequest types. Inventory location management moves to eBay.sell.inventory.
45bf087 taught getTransactions to join an array of filter criteria, but left the other six filter-taking methods on plain strings. Because axios is configured with paramsSerializer {indexes: null}, passing an array to any of them emitted the parameter repeatedly instead of once, so the half-applied convenience was worse than none. getPayouts, getPayoutSummary, getTransactions, getTransactionSummary, getOrderEarnings, getOrderEarningsSummary and getBillingActivities now all take `string | string[]` and share a toFilter helper. BREAKING CHANGE: getOrderEarningsSummary takes an options object ({filter}) instead of a positional argument, matching its siblings, and the limit/offset parameters of getOrderEarnings and getBillingActivities are typed as number rather than string. All four methods were introduced in this unreleased major, so no published API changes.
IEBayApiRequest gained a required `patch` method when sell account v2 introduced eBay's first PATCH operation, but seven in-repo stubs were never updated. mocha's loader chain does not type-check the specs, so the errors stayed latent until tsc was pointed at test/.
update-readme-release.cjs could not match a prerelease: the regex required a closing backtick straight after the patch digit, so `v10.0.0-RC.1` never matched. readVersion null-dereferenced and writeVersion silently no-opped, which is why the README still advertises RC.1 while package.json is at RC.2. It now matches prerelease and build metadata and throws a message naming the missing line. fetch-open-api.cjs wrote whatever came back on a 200 straight into specs/. Akamai Bot Manager answers a blocked request with 200 and an HTML challenge page, so a bad run would overwrite a good committed spec and only surface later as a confusing gen-openapi parse error. It now parses and sanity-checks the document before writing, decodes the body as UTF-8 (9 of 36 specs contain multi-byte characters that a chunk boundary could have corrupted), follows redirects, refuses a non-.json filename, exits non-zero when any download fails, and reports the operations a refresh drops so the matching client can be pruned. Adds tsconfig.check.json and an `npm run typecheck` covering src, test and examples, wired into prerelease. examples/ was previously in no tsconfig at all, which is how an extensionless import survived in clientAlerts.GetPublicAlerts.ts; that is fixed here. Also adds publishConfig.tag so a release candidate cannot claim the `latest` dist-tag (npm does not infer one from the semver suffix), drops the readline dependency (a 2013 stub of Node 0.4's readline; the examples resolve the builtin), pins openapi-typescript to the 7.13.0 that generated the committed types, overrides brace-expansion to clear a high-severity advisory, points the `rc` script at the current branch instead of a hardcoded `next`, and removes the CLAUDE.md line from .gitignore, which did nothing because the file is tracked.
The migration guide omitted breaking changes a reader needs. It never mentioned the buy browse cart removals (and attributed their types to buy marketing), nor the commerce notification test() -> testSubscription() rename, which throws "is not a function" at runtime with no compile-time warning. The post-order entry gave a count of 29 methods without naming any of them. Every removal is now enumerated, grouped by API, with the replacement where one exists. Adds sections for the renamed method, the newly required IEBayApiRequest.patch member, and the behaviour changes in this release (header precedence, the media and logistics content types, the finances filter arrays). Corrects the implementation status table against the shipped specs: ten versions were stale, and the Commerce row had dropped the Message and Feedback APIs, which are implemented, wired and tested. Adds sell account v2. Other README repairs: the digital signature list pointed five of six post-order methods at .inquiry. when they live on return/cancellation, and named issueCaseRefund, which was removed in cb1af3f; the OAuth2 section documented refreshAuthToken()/refreshClientToken(), which are event names, not methods (they are refreshUserAccessToken() and obtainApplicationAccessToken()); the docs dedup in 9613316 left an empty h3 followed by an h2 nested inside an h3 subsection; "RESTful API" appeared as two headings so the TOC anchor resolved to the status table rather than the usage section; and the TOC order no longer matched the document. CHANGELOG: removes a verbatim duplicate of the RC.1 and RC.0 sections, a "# Conflicts:" artifact standard-version harvested from a merge commit body, and completes a breaking-change bullet that was truncated mid-sentence.
Added in c9947a3 so a release candidate could not claim the `latest` dist-tag. The next publish from this branch is the stable 10.0.0, where it would do the opposite and leave `latest` pointing at 9.6.0. Publish any future prerelease with an explicit `npm publish --tag next`.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
This is the v10.0.0 major release. It brings the entire RESTful layer up to eBay's current published OpenAPI specs, migrates the Buy Order API to v2, removes endpoints eBay has decommissioned, adds the new operations eBay introduced, hardens the spec-fetch tooling, and fixes several binary-payload bugs.
Because eBay removed a number of operations, this release contains breaking changes and warrants the major version bump (
9.x → 10.0.0).Buy Order API migrated
v1 → v2The Order API was rebuilt on eBay's
buy_order_v2spec. eBay's v2 only exposes the guest checkout flow, so the member-checkout, proxy-guest-checkout, payment-info, initiate-payment and place-order operations no longer exist and were removed.basePathchanged/buy/order/v1→/buy/order/v2initiateCheckoutSession,getCheckoutSession,placeOrder,applyCoupon,removeCoupon,updatePaymentInfo,updateQuantity,updateShippingAddress,updateShippingOption,getPurchaseOrder, the entire*ProxyGuest*family,placeGuestOrder,initiateGuestPayment,updateGuestPaymentInfoinitiateGuestCheckoutSession,getGuestCheckoutSession,applyGuestCoupon,removeGuestCoupon,updateGuestQuantity,updateGuestShippingAddress,updateGuestShippingOption,getGuestPurchaseOrderCreateSignInCheckoutSessionRequest,GuestPlaceOrderRequest,InitiatePaymentRequest,UpdatePaymentInformation,CheckoutSessionRequestWithoutPaymentDecommissioned methods removed
getAlsoBoughtByProduct,getAlsoViewedByProduct(+ removed the browse shopping-cart methods andAddCartItemInput/RemoveCartItemInput/UpdateCartItemInputtypes)eBay.sell.complianceis gonesetupQuickCampaign(+QuickSetupRequest) — thequick_setupoperation was retired by eBaymarkReturn*,checkReturnEligibility,closeCase,issueCaseRefund,createInquiry, etc.), with the matching operations pruned from the custom specsInputStreamtype removed (dropped from eBay's spec);uploadVideobody is nowany✨ New API methods (from refreshed specs)
getCombinedShippingRules,create/updatecalculated & flat shipping rules, promotional shipping rule,updateCombinedPayments) andgetUserPreferences/setUserPreferencesbulkCreateOrReplaceSalesTaxgetOrderEarnings,getOrderEarningsById,getOrderEarningsSummary,getBillingActivitiesgetHandlingTimes,getShippingCarriers,getShippingServices,getShippingLocations,getExcludeShippingLocations, and more)createDocument,createDocumentFromUrl,getDocument,uploadDocument), post-order documents (uploadPostOrderDocument,downloadPostOrderDocument,removePostOrderDocument),createImageFromFile,createImageFromUrl,getImageInfrastructure
PATCHsupport:Restful.patch(), pluspatchon theIEBayApiRequestinterface andAxiosRequestimplementation (backssetUserPreferences)redocly.yamlatbuy_order_v2🛠️ Spec-fetch tooling (
scripts/fetch-open-api.cjs)eBay moved the OpenAPI spec endpoints behind Akamai Bot Manager, which 403s a bare request. The fetch script now sends a browser User-Agent, keeps a cookie jar, and retries once with the issued bot-mitigation cookies. Verified 26/26 active specs return
200.sell/account/v2is intentionally excluded (its static contract has a dangling$refthat omitsSetUserPreferencesRequest) and is maintained manually.All RESTful specs were then refreshed to their current published versions (e.g. finances
1.17.3 → 1.19.0, metadata1.11.1 → 1.12.1, marketing1.22.2 → 1.23.2) and the TypeScript types regenerated.🐛 Bug fixes (binary payloads)
Surfaced by a parallel bug-hunt review of this branch:
createImageFromFile,uploadDocument,uploadPostOrderDocumentnow sendContent-Type: multipart/form-data(via the existingmultipartHeaderhelper) instead of the defaultapplication/json, which eBay rejectsdownloadPostOrderDocumentnow usesresponseType: 'arraybuffer'so theapplication/pdfresponse isn't corrupted by JSON decodinggetTransactionsnow comma-joins afilterarray instead of emitting repeatedfilter=paramsKnown follow-up
uploadVideosendsapplication/jsonwhere eBay expectsapplication/octet-stream(pre-existing, tracked in commerce.media.uploadVideo sends Content-Type: application/json instead of application/octet-stream #215)fetch-open-api.cjsexits0on partial download failures (dev tooling; low priority)✅ Verification
tsc --noEmit: 0 errorsnpm run build: OKnpm audit: 0 vulnerabilities (transitivebrace-expansion/form-data/js-yaml/qsadvisories resolved and merged from master)