CHANGELOG.md

eBay API Changelog

10.0.1 (2026-08-11)

10.0.0 (2026-07-29)

⚠ BREAKING CHANGES

• finances: 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.
• 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.
• a per-request Content-Type now overrides one set globally via apiConfig.headers. Previously the global value won.

Features

• finances: accept an array for every filter parameter (8aa5c3e)
• remove operations dropped from the refreshed specs (7146bf1)

Bug Fixes

• stop default headers from overwriting per-request headers (8bfa479)

10.0.0-RC.2 (2026-07-24)

⚠ BREAKING CHANGES

• 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).
• 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.
• Removed sell marketing setupQuickCampaign and the QuickSetupRequest type, and the commerce media InputStream type; all were removed from eBay's updated specs.
• 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.
• 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.

Features

• add new RESTful methods from refreshed specs (e1c8f69), closes #214
• prune decommissioned post-order methods (cb1af3f), closes #214
• refresh RESTful specs to latest published versions (7459bf8)
• remove Buy Order API v1 operations dropped in v2 (8ace7b6)
• remove decommissioned Finding API (e7f1625), closes #199 #216
• remove decommissioned Sell Compliance API (b4686f0)
• sell: add Stores API (2a6deab), closes #216

Bug Fixes

• correct media binary content types and finances filter array (45bf087)
• deps: resolve fast-uri high-severity advisory (c8d7708)
• make openapi fetch script work behind eBay Akamai bot manager (ce56ce3)

10.0.0-RC.1 (2026-02-22)

Bug Fixes

• eslint issues (beb7e46)

10.0.0-RC.0 (2025-09-08)

⚠ BREAKING CHANGES

• 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.

Features

• upgrading several APIs to latest version (2364543)

Bug Fixes

• trailing space (de793bf)

9.6.0 (2026-07-21)

Features

• feedback API v1 (c0b8adb)

Bug Fixes

• deps: resolve npm audit vulnerabilities (f412511)

9.5.2 (2026-05-11)

Bug Fixes

• resolve high-severity serialize-javascript CVEs and fast-xml-parser isArray type (c380413)

9.5.1 (2026-04-04)

Bug Fixes

• add missing type for GetSellerListResponse (4e6448a)

9.5.0 (2026-03-18)

Features

• add configurable XML entity expansion limits and global parseOptions (80e2645)

Bug Fixes

• deep-merge processEntities and remove redundant getParseOptions (26b2e41)

9.4.4 (2026-03-02)

Bug Fixes

• error handling for restful (770a43a)

9.4.3 (2026-02-21)

9.4.2 (2026-02-07)

9.4.1 (2026-02-06)

Bug Fixes

• deps: upgrade openapi-typescript to v7 (8bebad4)
• getCompatibilityPropertyValues_Filters (32ec670)

9.4.0 (2025-12-22)

Features

• message API v1 (fa23326)

9.3.1 (2025-12-06)

Bug Fixes

• run npm audit fix and update dependencies (8c3437d)

9.3.0 (2025-11-19)

Features

• add traditional API response types and update index exports (cf5d2eb)

9.2.2 (2025-09-22)

9.2.1 (2025-09-08)

Bug Fixes

• add missed sell account v2 specs (18df828)
• set axios paramsSerializer to null - no brackets (90555fb)

9.2.0 (2025-03-14)

Features

• Account API v2 (5aad6bc)

9.2.0-RC.0 (2024-12-20)

Features

• update sell inventory API to v1.18.0 (d3a4e27)

Bug Fixes

• #185 do not throw error on Warning (a1e939a)
• Added responseType and responseEncoding to sell.feed.getLatestResultFile/getResultFile for files to download correctly (ffe3850)
• Fulfillment API: getOrder(s) fieldGroups takes string, not string[] (a388dbb)
• getRateLimits - params are optional (9450863)

9.1.1 (2024-08-23)

Bug Fixes

• #179 refresh the token on 931 error (e47b93e)

9.1.0 (2024-07-02)

Features

• add "firstError" in EBayApiError (c2bff1e)
• make xmlBuilderOptions configurable (ce7f787)

9.0.3 (2024-06-27)

Bug Fixes

• change type of response status to number (f062fc9)
• version in README.md (0991cc3)

9.0.2 (2024-06-21)

Bug Fixes

• revert back to postForm because axios does not encode correctly (c369044)

9.0.1 (2024-06-20)

Bug Fixes

• update deps (14c41ab)

9.0.0 (2024-06-20)

Features

• update sell metadata to v1.7.1 (124ed0b)

9.0.0-RC.0 (2024-04-25)

⚠ BREAKING CHANGES

• refactor error handling

Bug Fixes

• improve Type in oAuth2 (28a9088)

• refactor error handling (05d40a9)

8.7.2-RC.0 (2024-03-29)

Bug Fixes

• #165 allow string as Metric value (f20f688)
• refresh Auth token if it's hard expired (1d8410f)
• use same timestamp in digital signature (20bc69a)

8.7.1 (2024-02-09)

Bug Fixes

• export commerce media (bd20570)

8.7.0 (2024-02-05)

Features

• add commerce media api (ab7dedd)

8.6.1 (2024-01-18)

Bug Fixes

• 🐛 fixes search cancellations request with query parameters (60133ab)

8.6.0 (2023-10-08)

Features

• removeComments is true to reduce module size (91725b4)
• update sell Marketing API v1.17.0 (c3acbfb)

8.5.1 (2023-09-28)

Bug Fixes

• handle invalid token in Shopping API (98b0aeb)
• Locale that is used for 'accept-language' and 'content-language' was mixed with LocaleEnum that should be used in Inventory API (dd4b71d), closes /community.ebay.com/t5/Post-Order-APIs-Return/error-when-posting-to-issue-refund-with-returnid/m-p/34000648#M14

8.5.0 (2023-08-29)

Features

• export request and param types (adc6cce)
• generate types with openai-typescript (62d6178)
• implement openai spec operations (035e8c8)
• improve more types (fb170ae)
• use openai typedef in query too (afdd9c6)

Bug Fixes

• ignore openapi generated folder in tslint.json (2d3e748)
• traditional api types (ac9cd61)

8.4.1 (2023-05-25)

8.4.0 (2023-01-27)

Features

• add setSignature method (de1b466)

Bug Fixes

• remove unused globals crypto (a3ceaab)
• show error message in browser since digital signature is not supported here (314211b)

8.2.0-RC.0 (2022-12-27)

Features

• digital signature #132 (9aedbb5)

8.3.0 (2023-01-18)

Features

• update restful sell marketing api to v1.14.0 (d76a6f1)

8.2.0 (2023-01-09)

Features

• update sell.account api to v1.9.0 (183d0ef)

8.1.0 (2022-12-27)

Features

• update sell.feed API (a17d9e3)

Bug Fixes

• reverts types in package.json (aac52a3)

8.0.1 (2022-12-21)

8.0.0 (2022-12-21)

8.0.0-RC.0 (2022-12-08)

⚠ BREAKING CHANGES

• output esm and cjs

Features

• output esm and cjs (b37d96e)

Bug Fixes

• standard-version ext (df6b7e3)

7.1.3 (2022-12-03)

Bug Fixes

• get access token before calling traditional API (a4a3123)

7.1.2 (2022-11-22)

7.1.1 (2022-11-03)

7.1.0 (2022-11-03)

Features

• added developer key management API (75ccb60)

Bug Fixes

• add missed oas3 file (cce7c9d)

7.0.2 (2022-06-29)

7.0.1 (2022-06-28)

Bug Fixes

• add missed sort parameter (f4cf095)
• fix enum used for refundMethod (99203d2)

7.0.0 (2022-03-18)

⚠ BREAKING CHANGES

• add "returnResponse" config for API. If set to true, return the response instead of data.

Features

• add "returnResponse" config for API. If set to true, return the response instead of data. (41a8abb)

Bug Fixes

• fromEnv() make EBAY_DEV_ID optional (9c90bfa)

6.2.0 (2022-03-06)

Features

• add "default" export for esm (d2454d9)

Bug Fixes

• add types and enums for package dimensions and addresses (97404b9)

6.1.0 (2022-02-08)

Features

• Update issue templates (5c4f17f)

6.0.0 (2022-02-08)

⚠ BREAKING CHANGES

• rename package name from '@hendt/ebay-api' to 'ebay-api'

• rename package name from '@hendt/ebay-api' to 'ebay-api' (fa61e14)

5.3.1 (2022-02-08)

5.3.0 (2022-01-21)

Features

• add Merchandising API #103 (f82f295)

Bug Fixes

• correct example file name (507b298)

5.2.1 (2022-01-05)

Bug Fixes

• allow fieldGroups in fulfillment.getOrders call (6da3fd0)
• commerce.translations oas test (c80f1af)

5.2.0 (2021-12-17)

Features

• add fieldGroups param in fulfillment.getOrder() (23562be)

5.1.1 (2021-12-03)

Bug Fixes

• use "http" in xmlns for finding API #14 (f8ea062)

5.1.0 (2021-11-23)

Features

• update buy browse API (6ca0334)
• update restful notification api to v1.2.0 (91e5de3)
• update sell analytics, metadata and recommendation API and oas (214c0b0)
• update sell compliance API (aed292c)
• update sell fulfillment API (274f2f4)

5.0.3 (2021-11-11)

Bug Fixes

• remove stripCode instead check if window is defined (65eb840)

5.0.2 (2021-11-11)

Bug Fixes

• declare property 'id' for every Restful API since constructor.name is not reliable (71ce1ad)

5.0.1 (2021-11-11)

Bug Fixes

• remove restful 'Accept-Encoding' header in browser environment. (dd9db62)

5.0.0 (2021-10-28)

⚠ BREAKING CHANGES

• target ES2020 and Node >= 14

• target ES2020 and Node >= 14 (81c1973)

4.0.4 (2021-10-28)

Bug Fixes

• traditional: use https in shopping API and finding API (c1fecc0)

4.0.3 (2021-10-19)

Bug Fixes

• shopping: use iaf token in shopping API (f24f24d)

4.0.2 (2021-10-12)

Bug Fixes

• traditional: only return api error if Ack is Failure #93 (8f30eed)
• types: make legacyReference in RefundItem optional (5aa2e9e)

4.0.1 (2021-09-09)

Bug Fixes

• version in README.md (46263e6)

4.0.0 (2021-08-27)

4.0.0-RC.1 (2021-08-27)

Bug Fixes

• keep function name in minified version (e4e58cc)
• remove custom User-Agent (86cde05)
• revert back to plain xml body since form-data with axios has weird issues (45870d5)

4.0.0-RC.0 (2021-08-26)

⚠ BREAKING CHANGES

• set per default to EBAY_US

Features

• allow string in setCredentials() (b17e300)
• eps (WIP) (6e7db5f)
• upload picture to eps with working example (2d6d46c)

Bug Fixes

• eslint (2e8727a)

• set per default to EBAY_US (33b23de)

3.3.3 (2021-08-26)

Bug Fixes

• types: set ShippingFulfillmentDetails.shippedDate as optional (2894739)

3.3.2 (2021-08-15)

Bug Fixes

• IssueRefundRequest type (8a75516)

3.3.1 (2021-08-12)

3.3.0 (2021-07-25)

Features

• add and use ReturnMethod, ReturnShippingCostPayer, and RegionType enums (5a63eee)
• add response data to error meta (021e84f)

Bug Fixes

• add EBAY_BE marketplace (c9330be)
• make changelog headings consistent (63dc373)

3.2.0 (2021-04-25)

Features

• add Marketplace enum and change types of marketplaceId params to use enums (6b5eb93)

Bug Fixes

• autoRefreshToken in traditional api call (faadf94)
• use travis env for codecov (6cb528c)

3.1.0 (2021-04-07)

Features

• add charity API (103e116)
• add commerce notification api (b7d1f3b)
• add deal api (8bb2479)
• add marketplace insights API (3788ade)
• add sell feed api (4d85a68), closes #45
• add sell listing API (fef65ac)
• add sell logistics api (2a289b8), closes #43
• add sell Negotiation api (0dd0599), closes #41

3.0.0 (2021-04-07)

⚠ BREAKING CHANGES

• rename oAuth2 to OAuth2

Features

• add apix/apiz and make restful api configurable (081dab0)
• add ContentLanguage enum (a0a3d11)
• improve error handling (c1fbdbb)
• use Locale enum (edcb921)

Bug Fixes

• eslint error (2479c23)

• one more eslint error (7bcfdbc)

• use RecipientAccountReferenceType (42bab48)

• rename oAuth2 to OAuth2 (755a840)

2.2.1 (2021-03-11)

Bug Fixes

• remove lib before build (8cc6cbb)

2.2.0 (2021-03-11)

Features

• add some missing enums (6d923d1)

Bug Fixes

• add package-lock.json to bumbFiles (b82a901)

2.1.1 (2021-03-09)

Bug Fixes

• minor fix for update readme script (eaad8f9)

2.1.0 (2021-03-09)

Features

• finance api added (25f0f94)

Bug Fixes

• update readme script (cbfea68)

2.0.0 (2021-03-09)

⚠ BREAKING CHANGES

• refactoring
• parse attributes on eBay xml response

Features

• apply default parse options to xml request (dd95255)
• enable arrayMode in XML response (bc91c79)
• parseTrueNumberOnly in xml (c5cb5ed)
• remove AxiosRateLimited and Expose Axios instance (fe37918)
• support additional header in XML request (bd52f33)

Bug Fixes

• change back to git dependency (d4017be)

• change to https for travis (2c59820)

• improve arrayMode (4099dfb)

• parse attributes on eBay xml response (6970ae6)

• remove List from arrayMode (691c194)

• refactoring (bcb3a5e)

1.5.1 (2021-02-21)

Bug Fixes

• udpate comment and return type to more accuratly decribe what is returned from eBay (6ea2458)
• update call to include correct response type (763df8a)

1.5.0 (2021-02-21)

Features

• add fetchItemAspects method (457cb42)
• updated taxonomy url to GA version per eBay release notes (1c44ad1)

Bug Fixes

• updated testing oas3 file per eBay docs (b758222)

1.4.2 (2021-01-07)

Bug Fixes

• Make Region.regionType optional (9486ec6)
• Remove sku from Compatibility (506d988)

1.4.1 (2020-10-22)

Bug Fixes

• Create type EbayOfferDetailsWithId and use that for updateOffer (0445e05)
• Merge pull request #19 from olliechick/fix-types (a999b12)
• wrap glob pattern in single quotes (ac2eb5f)

1.4.0 (2020-10-02)

Features

• Return refreshed token from refreshAuthToken (b7075c3)

Bug Fixes

• fix siteId check (3c8c1cb)
• fix type of PaymentPolicyRequest.paymentMethods (e8a97a7)
• Mark non-required types in PaymentPolicyRequest and children as optional (efaad9d)
• Mark non-required types in ReturnPolicyRequest as optional (2323344)
• remove requirement for siteId in eBayConfig; instead, throw errors when it is needed but not provided (2df33f8)

1.3.0 (2020-09-25)

Features

• Sell: add missed api calls (4749eba)
• Sell: add missed API calls (5aa03c3)

1.2.1 (2020-06-16)

Bug Fixes

• PostOrder: create return endpoint (957c739)

1.2.0 (2020-06-09)

Features

• add new enum and fix RefundDetail type (3c15ffc)

1.1.2 (2020-06-01)

Bug Fixes

• fix wrong class name (cf93a47)

1.1.1 (2020-05-31)

Bug Fixes

• wrong name for restful cache (dce891b)

1.1.0 (2020-05-31)

Features

• add "prompt" login (f876451)
• cache restful api objects (45220b9)

Bug Fixes

• post order issue_refund missed payload param (2e735e6)

1.0.1 (2020-03-19)

Bug Fixes

• bump (d7faf4d)

1.0.0 (2020-03-19)

Bug Fixes

• update readme (9c487c9)