• Internal Usage Metrics enhancements

• Infrastructure enhancements

• Issue related to anonymous tokens

• Resolved loophole that allowed a Subscription Integration and OrderCheckout Integration to be used on the same API client

• Resolved issue resulting in 500s related to requesting refresh tokens

• Performance enhancements for product sync

Fixed

• Intermittent 500 on updating a payment on a Subscription

• Group Ordering capabilities are now in beta

  • Allow multiple people to add items to a single order using order invitations to generate tokens

  • Subject to change based on customer feedback

• HTTP Delivery Targets now support custom headers

Fixed

• Payments on Subscriptions can now be updated

• MeSubscriptionAdmin is no longer required to view Subscription Items

• OrderReturnResponse now accepts xp. If you need to update OrderReturn.xp based on your calculations in middleware, send the entire xp object back to OrderCloud to be updated.

• Minor additions to the OpenAPI spec

Fixed

• Unhandled error when attempting to delete a Subscription Order

• Defining a custom authorization header is now supported on Webhooks, Promotion Integration and Subscription Integration

  • New Properties: CustomAuthHeaderName and CustomAuthHeaderValue

  • The header can be used as an alternative to HMAC validation (using the HashKey) in the event your consumer only supports authorization header validation

  • Used to to verify that any request sent to your webhook can be trusted and is from OrderCloud

Fixed

• Unexpected error related to deleting a lineitem on a submitted order

• Indexing issue with child products when unassigning a parent product from a catalog

• Integration event PATCH causing authorization header to be removed

• Unexpected error related to deleting a bundle item on an order

• Performance enhancements to product sync

• Defining a custom authorization header is now supported on Integration Events (OrderCheckout, OpenIDConnect, OrderReturn, AddToCart)

  • New Properties: CustomAuthHeaderName and CustomAuthHeaderValue

  • The header can be used as an alternative to HMAC validation (using the HashKey) in the event your consumer only supports authorization header validation

  • Used to to verify that any request sent to your webhook can be trusted and is from OrderCloud

  • Custom authorization headers on webhooks and other outbound events coming soon

Fixed

• Erroneous UserID Properties removed from OpenAPI spec assignment models

• Promotion Integration

  • As powerful as the Rules Engine is, you may sometimes have a use case that is too complex to solve using the properties and functions accessible within an expression, enter the new Promotion Integration.

    • Continue to leverage all the flexibility and built in validation of Promotions, such as expiration dates, redemption limits, and eligibility

    • When it comes time to apply the discount, if the order is eligible, OrderCloud will call out to your predefined middleware for discount information.

• Resolved an issue that was intermittently causing stale data on LineItems immediately after order submit

• Ad-hoc Products Expansion. Ad-hoc products can now be used in conjunction with Products in OrderCloud.

  • When you call to add a product to an order, if you have the AddToCart integration event enabled, we will first check to see if the product exists in OrderCloud and add it to the order if so, if not, we will then call out to your middleware for the Product information.

Fixed

• Issue where LineItem.PriceOverriden was being set to true unexpectedly is now resolved.

• Beta flag allowing us to release features for testing and feedback

  • Features in beta will be clearly labeled in the portal and the SDK method descriptions

  • Features in beta will not be available in production, a 403 error will be returned

• Inventory Integration

  • Send Inventory Changes to the Delivery Target(s) of your choice

  • Ability to send every change or only changes where the NotificationPoint is hit

  • QuantityAvailable and PreviousQuantity will be included in the payload

  • Use this feature for things like alerting purchasing managers to re-order a product, or back-in-stock notifications for customers

• New Properties on Product Collection Entries: DateAdded (read-only) and ListOrder

  • Useful for sorting collection entries

  • New endpoint POST v1/productcollections/{productCollectionID}/products

    • Include ProductID and ListOrder (optionally) in the request body

• Performance enhancements to promotion evaluation

Fixed

• Subscription Integrations are now disabled when restored to Staging

• Define multiple cryptographically secure ClientSecrets on a single API Client

  • Existing ClientSecrets will continue to function normally, but we highly encourage transitioning to the new methodology to stay aligned with security best practices

  • New model and endpoints explained in more detail here

Fixed

• Issue has been resolved where InventoryRecords were not found when the user making the API call to add a line item was not the Order.FromUser

• NotificationPoint added to InventoryRecords and Variants to support an upcoming inventory integration feature

• Performance enhancement to listing promotions

• Token Revocation

  • Existing user tokens are now revoked automatically when a user is deactivated or the user's password is reset

  • A user's tokens can now be explicitly revoked through new endpoints for admin, buyer, and supplier users

    • DELETE v1/adminusers/{userID}/tokens

    • DELETE v1/buyers/{buyerID}/users/{userID}/tokens

    • DELETE v1/suppliers/{supplierID}/users/{userID}/tokens

  • Additionally, a user can revoke their own tokens without needing an elevated role by calling DELETE v1/me/tokens, which is functionally equivalent to a "sign me out of all devices" feature

• The maximum duration of the refresh token has been extended from 43200 minutes (30 days) to 524160 minutes (364 days) to accommodate client applications that desire longer periods of inactivity before forced logout (e.g. mobile applications, shopping sites). Use token revocation as described above to require a new login

• EntitySync now has properties, SyncEntityChanged and SyncEntityDeleted, to allow disabling incremental syncs for changes and deletions, while maintaining the ability to run a manual sync (similar to ProductSync)

• Listing Eligible Promotions now returns an Amount, which is the discount amount that would be applicable if the promotion was applied to the order

• Entity Sync now supports Buyer companies and UserGroups

• Password Configuration now supports a LockoutDuration of 0. If a user has exceeded AllowedFailedAttempts and LockoutDuration is 0, a manual intervention via the API will be required in order to allow the user to try again.

  • The new routes each require the Admin role specific to the user type.

    • POST v1/buyers/{buyerID}/users/{userID}/unlock

    • POST v1/adminusers/{userID}/unlock

    • POST v1/suppliers/{supplierID}/users/{userID}/unlock

• Performance enhancements to querying Inventory Records

Fixed

• Promotion calculation bug when multiple promotions applied

• Issue related to child product xp inheritance on the Order Worksheet when certain special characters are present

• Enhancements to internal usage metrics

• Infrastructure clean up

• Updates to internal usage metrics reporting

• Infrastructure changes to support enhanced data security features

• Promotion bug related to items.discountedtotal function released yesterday

• Preventing a bad expression from being used with any() function in a Promotion

• Gratuity has been added the Order model

  • An optional non-negative decimal

  • In addition to gratuities/tips, it can be used for donation based or pay-what-you-wish (PWYW) orders

• A new Rules Engine expression items.discountedtotal was introduced to take into account discounts on already applied promotions when applying a new promotion.

  • This can be useful in scenarios where you allow stacking discounts and want to calculate additional discounts off the discounted price.

Fixed

• Minor ProductSync bugs

• Promotion issue when using the incategory function when multiple promotions were applied

• Product caching issue after an associated PriceSchedule was deleted

• Resolved an issue in ProductSync related to inventory

• QuantityLimitPerOrder added to Promotions. When defined the ValueExpression will be the discount applied to each qualifying quantity of eligible line items. More details here

• EntitySync now includes InventoryRecords that allows you to configure OrderCloud to transmit inventory record updates to your integrations via the delivery target of your choice. For performance reasons, InventoryRecords will not be sent in any newly created ProductSync configurations, existing configurations are not impacted. Product level Inventory (not associated with an InventoryRecord) will still be included in ProductSync

Fixed

• Resolved an bug related to assigning child products to categories

• RedemptionLimitPerUser is now only counted against orders that have been submitted and are in the Open or Completed status.

• Fixed a bug that allowed an ItemLevel promotion to be created without the item token in the EligibleExpression

• Promotions can now be added or removed from orders by users with OrderAdmin after submit

• Subscription NextOrderDate will no longer increment one hour ahead each time it processes

• ApiClients associated with a webhook can now be deleted, was throwing a 500 prior to the fix

• Rules Engine item.incategory() now works for child products assigned to categories that their parent is not assigned to

• Variant information was missing from LineItems if variants had been regenerated, current information will now be populated as long as a variant with a matching ID exists

• Custom pricing (sale, subscription, bundle) was being miscalculated in certain scenarios, including when changes were made to a price schedule after a lineitem had been created.

• Child Products can now be assigned to their own categories.

  • The Parent Product must be assigned to the catalog that the category exists in.

Fixed

• 500 error on PUT v1/cart

• One time Addresses on LineItems were being overwritten on submit in certain cases

• Supplier pricing bug where product price was inaccurate in the cart

• Bidirectional Content Hub Integration

  • Support to sync product data between Content Hub and OrderCloud, see documentation for detailed configuration information.

  • Integration between OrderCloud and Content Hub creates a product shell in Content Hub in your specified schema any time a product is created in OrderCloud. The intent of this integration is to allow seamless editing of product content if you create products in OrderCloud. No additional product changes/updates in OrderCloud will be synced to Content Hub, the integration is only meant to create a record in Content Hub for you.

  • Integration between Content Hub and OrderCloud tracks changes to three properties you define as a unique ID, Name and Description on your Content Hub model. These properties mapped to OrderCloud’s Product.ID, Product.Name, and Product.Description will be kept up to date with the values in Content Hub. The integration will also give you the option of syncing flat properties to OrderCloud’s Product.xp (non multi-language/taxonomy fields), and will also sync Content Hub asset Public Links to OrderCloud’s Product.xp.Images as an array of objects containing URLs for the Original, Thumbnail and Preview - depending on the configuration of the assets' public links.

Fixed

• Fixed an issue with auto apply promotions not being added correctly.

• Two new properties on Promotion:

  • Can only be used on Promotions where LineItemLevel is true.

    • ItemLimitPerOrder

      • Positive integer that defines the maximum number of items a given promotion will be applied to

    • ItemSortBy

      • Comma delimited string of line item properties

      • Sort descending by using !

      • Supports sorting on xp

      • If no value is provided, items will be sorted by the default value which is DateAdded ascending

  • Sample use case: 30% off the least expensive 3 items if a user spends at least $50

{
  "Code": "30OFF",    
  "LineItemLevel": true,
  "ItemLimitPerOrder": 3,
  "ItemSortBy": "LineSubtotal",
  "EligibleExpression": "order.Subtotal >= 50",
  "ValueExpression": "item.LineSubtotal * .3"
}

• New Rules Engine function inparentcategory('{categoryID}')

  • checks the category tree for any products assigned to the category specified or any of it's children, at any depth

Fixed

• Resolved a bug that prevented Subscription Reminders from being sent in the future if a Subscription failed to process

• Throw a helpful error if a webhook URL doesn't begin with HTTP

• Provide more helpful error data on certain promotion errors

• Recipient Locale and BuyerID are now populated in Message Sender payload.

• Order Validate and Submit now throw an error, as expected, when an item that is no longer purchasable is on the order. This includes things like inactive products, products no longer assigned to catalogs, etc..

• Prevent setting IsAnonBuyer = true on an API Client where a Seller User is set as the DefaultContextUserName, and vice versa.

• The delivery configuration flag is now honored when it is disabled. All existing delivery configurations have been enabled when releasing this fix in order not to break any existing functionality.

• Resolved incorrect promotion discount amount when percentage off promotions that include either order.PromotionDiscount or item.PromotionDiscount in the value expression are combined on an order.

New

• Performance enhancement making it less likely for one marketplace's product updates to delay updates performed by other marketplaces.

• The rules engine now supports an ifs() function.

  • This can be used to support evaluation of tiered threshold discounts. For example: spend $10 on Category A get 5% off, spend $30 get 10% off, spend $50 get 15% off would be written like this:

    • EligibleExpression: "items.total(product.incategory('A') >= 10 and item.product.incategory('A')"

    • ValueExpression: "ifs(items.total(product.incategory('A')) >= 50, item.LineSubtotal * .15, items.total(product.incategory('A')) >= 30, item.LineSubtotal * .10, item.LineSubtotal * .05)"

  • The final parameter in the function is the fall back (think of it as default in a switch statement, or an else) that is used if none of the conditions are met, in this case, we included the minimum spend in the eligible expression, so the fall back is a 5% discount.

• The category "active" property was added to the published ProductSync schema.

• The impersonation access token duration has been updated to either 60 minutes, or the length of the token duration of the API Client impersonation is configured with, which ever is greater.

• Delivery configuration introduces a new delivery target for Cosmos DB.

• Promotions owned by the Marketplace Owner can now be applied to orders where a Supplier is the ToCompanyID

Fixed

• Resolved a bug that did not allow an order to be forwarded again after deleting a forwarded order.

• Filters are now being evaluated correctly when calling GET v1/me/products/{productID}/sellers

• Delivery configuration introduces a new delivery target for Azure Tables.

• The AzureBlob delivery configuration target now allows you to override the default container name.

• The OIDC state token is now valid for 15 minutes instead of five

• LineItem.ShipFromAddressID can now be set to a Supplier Address

• EntitySync now supports synching Suppliers to the delivery configuration of your choice.

Fixed

• Prevent a 500 if a null value is passed into the LineItem.Specs array

• EntitySync now supports synching Admin, Buyer and Supplier users.

• Message Senders now have an AllowAllBuyers property which allows you to forgo explicit message sender assignments. Helpful in marketplace with many buyers who all need to receive the same emails

  • defaults to false

Fixed

• Bug that inadvertently removed supplier specific product assignments has been resolved

• Reversed a change made in v1.0.326 that incorrectly limited xp characters on integration event responses

• Child Products

  • Now supported in ProductSync.  IsParent and ParentID properties added to payload.  Children are published with full inheritance.

• DateCreated now available on Subscriptions

Fixed

• IntegrationEventResponse is now enforcing the documented limit of 8000 characters on xp

  • On 03/13/2024 it was determined this limit was not valid, it was removed it in v1.0.327

• New endpoint and MessageSender: ForgotUsername

  • POST v1/username/retrieve allows users to retrieve forgotten usernames by providing an email address if the corresponding message sender is setup

  • This addition will result in a breaking change to the SDKs only as we are consolidating forgotten passwords and forgotten usernames under ForgottenCredentials

• Marketplace owners can now create explicit product assignments for suppliers with price schedules they own

  • correct pricing should also now be returned on product list calls when defining a sellerID even when that seller does not own the price schedule

Fixed

• prevent a 500 from occurring when attempting to make a call as a deleted user

• EntitySync

  • OrderCloud introduces the ability to publish base entities to the destination of your choice.  You will be notified when the entities are created, updated or deleted via any of the configured delivery targets.

  • The current release allows you to synchronize categories, with many more entities in the near future.  This is just the beginning.

• New properties on Lineitem OutgoingOrderID and IncomingOrderID

  • Only populated for Marketplace Owners, filtering is supported

  • This property will allow a marketplace owner to easily determine which orders a given lineitem is associated with

• Child Products now inherit Parent Product properties on Lineitem.Product

Fixed

• Removed an erroneous error when attempting to add a lineitem to an order that had an invalid promotion applied.

  • Validate and Submit will still throw errors for this invalid promotion, we just no longer prevent the new lineitem from being added

• Fix for Message Senders not triggering when Message Sender xp is null

• Added better error responses for OIDC issues

• IsOnSale

  • Now exposed on LineItems. This will allow you to reference the property in rule engine expressions for Promotions and ApprovalRules

  • Can now be filtered on when listing PriceSchedules

• A new ErrorConfig endpoint Validate allows configured error destinations to be tested to ensure they are properly configured. Invoking this endpoint will send a test message to the configured destination.

• Removed RedemptionCode from SpendingAccount model to avoid confusion. This value did not control any behavior in OrderCloud and was not being used by any customers.

Fixed

• Inventory Records now work correctly with variants when VariantLevelTracking is false at the product level

• An error is now thrown if you attempt to apply a promotion to an order that is not awaiting approval or unsubmitted

A Delivery Configuration ID can now be assigned to Message Senders providing you the ability to publish these messages to the destination of your choice.

• Added routes to Cart API for setting and updating one time shipping and billing addresses

Fixed

• Listing promos before cart exists now returns an empty list page instead of null values

• QueryParams object added to all webhook JSON payload bodies

• Error configuration allows you to define a marketplace level delivery configuration which will deliver customer specific errors regarding asynchronous operations (such as Product Sync and post web hooks) to the custom delivery target of your choosing.  A great debugging tool when setting up a marketplace with asynchronous integration endpoints.

• BuyerID is now optional on ImpersonationConfigs. Omitting the BuyerID from the config will allow the impersonating user to impersonate any buyer user within the marketplace.

• customParams passed into ocrplogin endpoint for OIDC will now be persisted through the login process and passed to your SyncUserIntegrationEvent.

• All Webhooks have been migrated to use https if they were not already doing so.

Fixed

• An anon user would receive a 204 response when calling to transfer an order, even though the transfer failed because that is not a supported workflow. The call now returns a 403 as expected.

• Redirects are now disallowed on Webhooks

• Marketplaces with Premium Search for Orders enabled can now reference orderhist and itemhist in Rules Engine expressions on Promotions and Approval Rules

  • Examples
    User has placed more than four orders in the past year
    EligibleExpression: orderhist.count('1Y') > 4
    User has ordered a given product 10 or more times in the past 6 months
    EligibleExpression: itemhist.quantity('6M', 'Product.ID = {productID}') >= 10
    Give 1% of the total value of all orders placed in the past month as a discount
    ValueExpression: orderhist.total('1M') * .01
    

Fixed

• Unsubmitted orders with the status of Canceled were inadvertently being excluded from the nightly Unsubmitted Order Cleanup

• New endpoints to support adding Product Bundles to subscriptions

• Ability to use LineItem.Product.Inventory properties in rule expressions for promotions and approval rules

• We’re excited to present a new, often requested, feature: Product Bundles. This feature can be used in a variety of ways to help customers achieve their ecommerce goals.

  Possible Use Cases

  • I need new employees to purchase uniform bundles, I want to provide the products in the bundle at a discount and ensure they are purchasing a minimum quantity of each item.

  • I want to cross-sell complementary beauty products, so I create a bundle consisting of two or more products that are commonly used together at a slightly reduced price.

  • I know people buying video game consoles also likely need other equipment, to entice them to buy all of the items at once, I need a bundle that includes a console, headset, and choice of game.

Fixed

• Resolved a bug that resulted in a 500 when attempting to PATCH a cart that had not yet been created on the OC side

• Search 2.0 is now supported via the SearchIngestion Delivery Configuration. This can be used in conjunction with Product Synchronization.

• Azure blobs is now supported via the AzureBlob Delivery Configuration.

• PUT v1/me/orders?anonUserToken={anonUserToken} now supports transferring an order to a buyer user belonging to a different buyer than the anonymous user

Fixed

• Resolved a bug caused by attempting to delete a product, or supplier address associated with an InventoryRecord

• Throw a friendly error when ShipEstimates is empty and an attempt to set ship methods is made

• Now populating Variant and Price Schedule information on the lineitem when the item is created after the order has been submitted

• Throw a friendly error when too many concurrent requests are made to an integration event

Order Synchronization allows you to synchronize your orders with the associated Delivery Configuration mechanism of your choice. This way, you will be notified anytime an order is submitted and of any changes it incurs in the future. 

Update

Webhooks can now be optionally configured to use the Delivery Configurations. This allows you to delivery their payloads to the delivery configuration mechanism of your choice.

• Added ParentID to LineItem.Product

  • Please note, this value will not be populated on orders submitted prior to this release.

Fixed

• Removed URL unsafe/reserved characters from password reset verification code

• GET v1/integrations/subscription now returns a 404 response instead of a 204 (No Content) response when the Subscription Integration does not exist for the selected marketplace

Product synchronization allows you to synchronize your catalog content with any system of your choosing using the pre-defined delivery mechanism that best suits your needs.

• The Http delivery target requires that a Secret be passed when it is configured. You should update any existing Http delivery target you have configured. Your existing Http targets will continue working as it is not an internal breaking change. Please refer to the Delivery Configuration for more information on the usage of the secret,

• An endpoint to allow listing product pricing for multiple sellers in a single API call: GET v1/me/products/{productID}/sellers

Fixed

• Buyer ID is now optional when creating a shipment to allow Suppliers to create shipments on AutoForwarded orders when they don't have the Buyer ID

• Added some missing endpoints for variant level inventory records

Delivery Configuration is a new way you configure the location of certain types of messages within the context of OrderCloud. These can include Known and Custom locations.  Custom locations allow you to have 100% control over the integration and allows you to deliver these messages to either an Https endpoint, Event Hub Namespace or a Kafka cluster.

Changed

Currently this new feature is leveraged by Tracking Events which has been modified to leverage Delivery Configurations.

• We first introduced ProductCollections just over a year ago, and we're excited to share we've added new functionality to support additional use cases beyond private lists of products. Adding new endpoints and a new AccessLevel property allows greater flexibility in the implementation of ProductCollections in your marketplace.
  Here are just a few ideas of how you could use the expanded functionality:

  • Marketplace Owners and Suppliers can now view ProductCollections with the ProductCollectionReader role allowing insights into which products customers are saving to their collections.

  • Allow a customer to create a grocery list and invite someone in their household to view and administer the items on it.

  • Encourage customers to make Sharable Holiday Wish lists for family members.

• Read more about the new functionality here.

• As announced last week, we are now enforcing that all Webhook Urls start with HTTPS on POST/PUT/PATCH. This will not impact any existing Webhook Urls unless you attempt to change them. We have communicated with customers who are not using HTTPS to give them an opportunity to update those and make any necessary changes before we begin enforcing the pattern on existing Urls.

Fixed

• Fixed a bug where calling POST v1/orders/{direction}/{orderID}/calculate was causing promotions to be recalculated incorrectly.
  

Please let us know if you have any questions. 

• New in() function added to the Rules Engine

Fixed

• Fixed an issue where auto applying promotions was failing after adding a lineitem.

• Promotions: expression evaluation will now take into account existing discounts when referencing item.LineTotal or Order.Total

• Subscriptions: order worksheet is now updated prior to sending to middleware

• New read only property DateApplied returned on the Promotion resource when listing promotions on an order

• New contains() method added to the Rules Engine

Fixed

• Fixed an issue where incorrect error was returned after attempting to set UnitPrice on subsequent lineitem PUT requests

• Fixed an issue with child/parent product visibility inheritance

This feature changed significantly in v1.0.293. Please see new release notes along with updated documentation.

OrderCloud introduces Tracking Events for commerce solutions, offering analytical insights and infrastructure for targeted systems. For more information, see Tracking Events

New Resource

TrackingEvent

{
  "ID": "",
  "EventType": "UserLoggedIn" | "LineItemAdded" | "LineItemUpdated" | "OrderSubmitted",
  "ClientID": "",
  "Name": "",
  "ConfigData":""
}

New Endpoints

• GET v1/integrations/TrackingEvents

• GET v1/integrations/TrackingEvents/{id}

• POST v1/integrations/TrackingEvents

• PUT v1/integrations/TrackingEvents/{id}

• PATCH v1/integrations/TrackingEvents/{id}

• DELETE v1/integrations/TrackingEvents/{id}

For more information, see Tracking Events API Reference