All notable changes to the ordercloud-javascript-sdk will be documented in this file starting in version 4. Migration guide for versions prior to version 4 are documented here
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Bring SDK up to date with API v1.0.368
- This version includes a breaking change that changes the return type for the ListEligiblePromotions method
- Bring SDK up to date with API v1.0.365
- This version includes a breaking change that corrects naming for Entity Sync methods
- Bring SDK up to date with API v1.0.359, which adds Gratuity to the Order model
- Bring SDK up to date with API v1.0.357, which adds QuantityLimitPerOrder to Promotions and introduces Inventory Record Entity Sync
- Bring SDK up to date with API v1.0.354
- Fixes an incorrect return type on CreatePaymentTransaction
- Bring SDK up to date with API v1.0.349
- Resolves error thrown when running in NextJS Middleware or Edge API routes
- Bring SDK up to date with API v1.0.338
- Bring SDK up to date with API v1.0.333
- Bring SDK up to date with API v1.0.332, which adds Suppliers to Entity Sync
- Error when trying to set token in edge runtime because trying to use document in server environment
- Bring SDK up to date with API v1.0.328, which adds Admin, Buyer and Supplier users to Entity Sync
- Bring SDK up to date with API v1.0.327
- Bring SDK up to date with API v1.0.325, which introduces Entity sync
- Bring SDK up to date with API v1.0.324
- This version includes a breaking change where forgotten passwords and forgotten usernames have been consolidated under ForgottenCredentials
- Bring SDK up to date with API v1.0.320 which adds IsOnSale to line items as well as a new error config endpoint
- Adds a new method for retrieving an identity token used by the Discover 2 proxy. More details in our product sync documentation
- Bring SDK up to date with API v1.0.315 which adds routes to Cart API for setting and updating one time shipping and billing addresses
- Fixes broken links within the SDK documentation
- Bring SDK up to date with API v1.0.309 which adds new endpoints to support Product Bundles in subscriptions.
- Bring SDK up to date with API v1.0.304 which introduces OrderSynchronization.
- Update SDK to optionally accept a custom axios adapter
- Bring SDK up to date with API v1.0.299
- Allow methods to be called without a scope parameter. When no scope is provided, OrderCloud will simply return all assigned roles
- SDK up to date with API v1.0.296, which introduces product synchronization
- SDK up to date with API v1.0.294, which adds support for listing product pricing for multiple sellers in a single API call
- SDK up to date with API v1.0.293, which contains some changes to Tracking Events and a new Delivery Configuration feature
- SDK up to date with API v1.0.292, which expands Product Collections
- SDK up to date with API v1.0.276, which introduces Subscription orders
- SDK up to date with API v1.0.274, which expands support for Inventory Records
- Update axios peer dependency version from ^1.0.0 to ^1.1.3
- A bug in axios was causing a filtering issue in our sdk
- Add new optional param anonuserid to Auth.Anonymous (part of new tracking events feature)
- Add missed changes for Tracking Events
- SDK up to date with API v1.0.267, adding support for Tracking Events
- SDK up to date with API v1.0.265
- SDK up to date with API v1.0.263
- new types for order returns
- OrderReturnCalculatePayload
- OrderReturnCalculateResponse
- LineItemReturnCalculation
- OrderCloudError was not serializing errors correctly (breaking change)
- Added support for axios ^1.0.0, version less than 1.0.0 no longer supported (breaking change)
- Updated OrderCloudError (breaking change more details in MIGRATION_GUIDE.md)
- Updated acceptable version range for axios dependency (v1.0.0 and up won't work)
- SDK up to date with API v1.0.251
- Introduces Cart API Endpoints
- Incorrect model type on DecodedToken.role #76
- New Feature: Ad-Hoc Products
- Ad-Hoc Products enables adding products from an external system directly to an OrderCloud order
- SDK up to date with API v1.0.241
- Introduces Product Collections
- SDK up to date with API v1.0.238
- Introduces Order Returns and adds Message Sender templates
- PriceScheduleID added to LineItems
- Added an optional
customRoles
array to the authentication methods to support authenticating with custom roles, in addition to standard ApiRoles.
- Docs now up to date with API v1.0.235 and previous changes to DecodedToken.role
- The ApiRole
InventoryAdmin
was removed from the OrderCloud API and is now considered a custom role. This role was removed from theApiRole
type definition. This could be a breaking change if your application uses the roleInventoryAdmin
. In this case, we recommend making this role a custom role.
- DecodedToken.role was not properly typed. It is now (ApiRole[] | ApiRole | undefined)
- SDK up to date with API v1.0.235
- bug where new models from v4.6.5 were not being bundled in the final output
- new models for message sender payloads
- new models for integration event payloads
- new models for oidc payloads and response #67
- bug where filter with boolean false was being dropped (#66)
- SDK up to date with API v1.0.233
- SDK up to date with API v1.0.231
- bug where methods for the Cert resource were using the wrong url
- bug where type parameters on certain complex models are wrong due to being ordered incorrectly. Affects model
OrderWorksheet
andOrderSplitResult
- SDK up to date with API v1.0.225
- SDK up to date with API v1.0.220
- SDK up to date with API v1.0.214
- cookieOption defaults were being clobbered and as a result defaults were not being applied
- SDK up to date with API v1.0.196
- SDK up to date with API v1.0.196
OrderCloudError
model not exported from public entry point
- Upgraded axios dependency to version 0.21.1
- SDK up to date with API v1.0.183
- Cookie options configuration to set path - defaults to root path if no path is provided.
- Prevent list options from being mutated. This lead to side effects for any user relying on the options object
- Typescript only: list options
searchOn
andsortBy
would produce type errors for valid types