Post Offer Details with Configuration API

This API provides the ability to configure an offer (either a product or promotion) and view updated prices, quantities, and attributes. The API returns the configured product details.

The configured product details are cached so that subsequent requests for the same configuration are retrieved with the data in the current cache layer.

Validations, prices, adjustments, overrides, rules, context, and so on are resolved internally. The Salesforce ID is not used as part of the request or response parameters. If validation fails, the OfferDetails structure is returned with an appropriate error message.

The CME Fall '20 release includes an Attribute Basket Cache feature. See Attribute Basket Cache Exclusion.

Starting in CME Spring '22, Digital Commerce supports Usage Based Pricing. You can define usage-based price charges for each Product. If the usage-based price is not available, you can set it up using Attribute-Based Pricing. You can update usage quantity by either:

  • Updating the UsageQuantity Field.

  • Using Attribute Binding, which takes precedence over the field update if both values are passed.

For more information, see Create Attribute Bindings for Usage Pricing.

  • The catalog should have CatalogCodec populated. Spaces are not allowed in CatalogCodec.

  • Products should have ProductCode populated. Spaces are not allowed in ProductCode.

  • Promotions should have Codec populated. Spaces are not allowed in Codec.

  • The catalog should be present with products and promotions attached to it as records under the CatalogProductRelationship__c object.

  • The catalog should be attached to a default price list through DefaultPriceListc field on Catalogc object.

  • Price list entries should exist for all products attached to the catalog.

  • Create a custom setting called CacheAPIFields with a value of true. CacheAPIFields is not required for CME 103.1.14 and later versions.

For API parameter names and descriptions, see Digital Commerce REST API

For detailed API response descriptions, see Digital Commerce REST API.