API Releases

As an evolution of a previous release, we enhanced the behavior of the image upload endpoints for the Product and Product Tailoring APIs to meet performance needs and improve the user experience.

When uploading Product or Product Tailoring images, the API now returns different status codes that indicate the status of the image upload at the time the API responds:

• A 200 OK response is returned when all sizes of the image have been successfully uploaded to the CDN.
• A 202 Accepted response is returned when the small size of the image has been successfully uploaded to the CDN, but the upload of the other sizes is still ongoing. These other sizes will be available soon thereafter.

The response status code depends on the size of the original image. If the image is small, the API responds with 200 OK, and if the image is larger, it responds with 202 Accepted.

To ensure optimal performance, this change will not be applied to all Projects at once, but will be rolled out gradually over the next few weeks. Therefore, some Projects may still respond with a 200 OK status code after only the small image size has been successfully created.

If you wish to learn more about this change, contact your Customer Success Manager.

After collecting feedback during the beta phase, we have moved Product Tailoring of images and assets out of beta and into general availability.

Visit the API reference to learn more about how to customize the images and assets of products for specific brands or regions.

After moving its functionality to the Merchant Center, we are deprecating ImpEx on 31 December 2024. By including this functionality within the Merchant Center, you can manage all aspects of your Composable Commerce Projects with a single interface and take advantage of single sign-on.

Replacement functionality, including CSV import/export, the API Explorer, and the GraphQL IDE, will become available in the Merchant Center between now and the deprecation date.

To be informed when replacement functionality becomes available, subscribe to the Merchant Center Release Notes RSS feed.

You can now choose how absolute discounts are applied to (Custom) Line Items in a Cart. Discounts can be distributed evenly or applied individually to each (Custom) Line Item, giving you more flexibility when creating promotions. Previously, discounts were only distributed proportionately to (Custom) Line Items.

Changes:

• [API] Added DiscountApplicationMode to the Cart Discounts API.
• [API] Added applicationMode field to CartDiscountValueAbsoluteDraft and CartDiscountValueAbsolute.
• [GraphQL API] Added the following types to the GraphQL schema: AbsoluteCartDiscountValue, AbsoluteCartDiscountValueInput, and DiscountApplicationMode.
• [GraphQL API] Added absoluteCart input field to the CartDiscountValueInput type.

You can now search across all Customers using their Custom Fields, making it easier to find stored information.

You can now subscribe to Messages for changes to Custom Fields and Types on Order Deliveries.

Changes:

• [API] Added the following Messages: DeliveryCustomFieldAdded, DeliveryCustomFieldChanged, DeliveryCustomFieldRemoved, DeliveryCustomTypeSet, and DeliveryCustomTypeRemoved.
• [GraphQL API] Added the following types to the GraphQL schema: DeliveryCustomFieldAdded, DeliveryCustomFieldChanged, DeliveryCustomFieldRemoved, DeliveryCustomTypeSet, and DeliveryCustomTypeRemoved.

The following changes were introduced in terms of GraphQL SDL:

You can now extend the Shopping Lists API with custom business logic using API Extensions. This feature allows you to trigger Extensions on create and update requests to Shopping Lists. By using API Extensions, you can integrate with other services and implement custom use cases, modifying the default behavior of the APIs to suit your business needs.

Changes:

• [API] Added shopping-list to ExtensionResourceTypeId.

To make the TypeScript SDK consistent with other Composable Commerce SDKs, we are replacing the v2 client with the v3 client.

The v3 client is Promise-based and enhances overall performance and reliability. This includes adding support for advanced features such as the concurrent modification middleware.

We will deprecate the v2 client on 30 October 2024. For more information on the differences between the v2 and v3 clients, see Migrate to the v3 client.

You can now filter Shopping Lists by TextLineItem key in queries.

Changes:

• [API] Added textLineItems(key) to Query Predicates on Shopping Lists for the Query ShoppingLists endpoint.

You can now change the order of Line Items in a Cart. This enhancement helps Customers identify which Line Items belong together. Previously, the order of Line Items in a Cart was based on the sequence in which the Line Items were added to the Cart.

Changes:

• [API] Added changeLineItemsOrder update action to the Carts and My Carts APIs.
• [GraphQL API] Added ChangeCartLineItemsOrder type to the GraphQL schema.
• [GraphQL API] Added changeLineItemsOrder input field to the CartUpdateAction type.

Composable Commerce is now available on Azure in North America, in addition to the existing Regions available on Google Cloud Platform (GCP) and Amazon Web Services (AWS). For more information about login and host URLs, see Login and Hosts.

With the addition of the store.key field identifier to Cart Predicates, merchants can now create certain Store-specific Shipping Methods with predicates. This enhancement is valuable in cases where several Stores ship to the same country and use different shipping rates per Store.

Changes:

• [API] Added store.key predicate field identifier to Cart Predicates.

We've added the active field to ShippingMethod. With this addition, you can now activate or deactivate individual Shipping Methods, as needed. This change helps you to manage Shipping Methods more efficiently by allowing you to temporarily deactivate them when not in use. Previously, you had to remove the Shipping Methods and create them again.

For all existing Shipping Methods, the active field has been set to true. Now, when you create or update a Cart or Order, you can only use an active Shipping Method.

Changes:

• [API] Added the Change Active update action to Shipping Methods.
• [API] Added active field to ShippingMethod and ShippingMethodDraft types.
• [GraphQL API] Added ChangeShippingMethodActive type to the GraphQL schema.
• [GraphQL API] Added changeActive input field to the ShippingMethodUpdateAction type.
• [GraphQL API] Added active field to the ShippingMethod type.
• [GraphQL API] Added active input field to the ShippingMethodDraft type.

You can now identify the address that was updated in Messages about changes to Custom Fields on Addresses. Previously, the Message did not identify which address was updated.

Changes:

• [API] Added an optional field, addressId, to the following Messages:
  • for Customers: CustomerAddressCustomTypeSet, CustomerAddressCustomTypeRemoved, CustomerAddressCustomFieldAdded, CustomerAddressCustomFieldChanged, CustomerAddressCustomFieldRemoved, BusinessUnitAddressCustomTypeSet
  • for Business Units: BusinessUnitAddressCustomTypeRemoved, BusinessUnitAddressCustomFieldAdded, BusinessUnitAddressCustomFieldChanged, BusinessUnitAddressCustomFieldRemoved
• [GraphQL API] Added the addressId field to the following types: CustomerAddressCustomTypeSet, CustomerAddressCustomTypeRemoved, CustomerAddressCustomFieldAdded, CustomerAddressCustomFieldChanged, CustomerAddressCustomFieldRemoved, BusinessUnitAddressCustomTypeSet, BusinessUnitAddressCustomTypeRemoved, BusinessUnitAddressCustomFieldAdded, BusinessUnitAddressCustomFieldChanged, BusinessUnitAddressCustomFieldRemoved.

With the addition of the origin field identifier to Cart Predicates, you can now target the value of the CartOrigin field. This enhancement lets you match against Carts originating from Customers, Merchants, or Quotes. For example, you can use this predicate to create Shipping Methods that are only available for Carts with a specific origin, such as those created by a Merchant.

Changes:

• [API] Added origin predicate field identifier to Cart Predicates.

You can now subscribe to Messages for changes to Custom Fields and Types on Embedded Prices.

Changes:

• [API] Added the following Messages: ProductPriceCustomFieldAdded, ProductPriceCustomFieldChanged, ProductPriceCustomFieldRemoved, ProductPriceCustomFieldsSet, and ProductPriceCustomFieldsRemoved.
• [GraphQL API] Added the following types to the GraphQL schema: ProductPriceCustomFieldAdded, ProductPriceCustomFieldChanged, ProductPriceCustomFieldRemoved, ProductPriceCustomFieldsSet, and ProductPriceCustomFieldsRemoved.

Business Units can now inherit Approval Rules from parent units higher up in the hierarchy. With Approval Rules inheritance, Business Units of type Division automatically inherit the rules of parent units. This can be helpful in situations where a Company has defined a set of Approval Rules that should also be applied to all associated Divisions. For each Division, you can choose the inheritance behavior and explicitly define which rules should apply. To modify the inheritance behavior, use the Change Approval Rule Mode update action.

Changes:

• [API] Added approvalRuleMode field to BusinessUnit, BusinessUnitDraft, Company, Division, and DivisionDraft.
• [API] Added BusinessUnitApprovalRuleMode type to Business Units.
• [API] Added Change Approval Rule Mode update action to Business Units.
• [API] Added BusinessUnitApprovalRuleModeChangedMessage Message.
• [GraphQL API] Added the following types to the GraphQL schema: BusinessUnitApprovalRuleMode, BusinessUnitApprovalRuleModeChanged, ChangeBusinessUnitApprovalRuleMode.
• [GraphQL API] Changed the BusinessUnitDraft type:
  • Input field approvalRuleMode was added to BusinessUnitDraft type
• [GraphQL API] Changed the BusinessUnit type:
  • Added the approvalRuleMode field to the BusinessUnit type.
• [GraphQL API] Changed the BusinessUnitUpdateAction type:
  • Input field changeApprovalRuleMode was added to BusinessUnitUpdateAction type

We introduced Product Tailoring of images and assets in public beta. You can now customize product images and assets for specific brands or countries modeled with Stores, to enhance your product offering in different markets.

Changes:

• [API] Added ProductVariantTailoring and ProductVariantTailoringDraft to the Product Tailoring API.

• [API] Added variants field to ProductTailoringData, ProductTailoringDraft, and ProductTailoringInStoreDraft.

• [API] Added Upload Product Tailoring Image endpoint to the Product Tailoring API.

• [API] Added Add Variant, Remove Variant, Add External Image, Move Image To Position, Remove Image, Set Images, Set Image Label, Add Asset, Remove Asset, Set Asset Key, Change Asset Order, Change Asset Name, Set Asset Description, Set Asset Tags, Set Asset Sources, Set Asset Custom Type, and Set Asset CustomField update actions to the Product Tailoring API.

• [API] Added ProductVariantTailoringAdded, ProductVariantTailoringRemoved, ProductTailoringImageAdded, and ProductTailoringImagesSet Messages.

• [GraphQL API] Added the variants field to the ProductTailoringCreated, the HasProductTailoringData, and the ProductTailoringDatatype.

• [GraphQL API] Added input field variants to ProductTailoringDraft type.

The new Customer Search API allows merchants to search across a large number of Customers within a Project with improved performance and enhanced query capabilities. The API is intended for back-office use cases, not for searching customer data in a storefront application. The API must be activated for the Project before it can be used.

Changes:

• [API] Introduced Customer Search API in public beta.
• [API] Added Change Customer Search Status update action on Projects.

After collecting feedback during the beta phase, we have moved the Product Search API out of beta into general availability.

With the Product Search API, you can create performant storefront search experiences for your products across Stores and Product Selections to enhance product discoverability. Standalone Prices are taken into account for sorting, filtering, and faceting.

The API's search query language supports compound expressions like AND, OR, NOT, and filter. This allows you, for instance, to filter out specific products from search results or display products based on color criteria, including those with or without a color attribute.

Find a comparison between the Product Search API and the Product Projection Search API on the Storefront search overview page.

Following features of the API remain in public beta:

• ProductSearchProjectionParams
• Facets

Merchants on Google Cloud Platform can now configure secure, private connections to commercetools HTTP API endpoints, ensuring they can access Composable Commerce services privately, inside their own VPC networks. Private Service Connect traffic is routed between VPC backends without intermediate hops. This ensures that traffic between commercetools and merchants' services remains private. It also has the added benefit of reduced latency and increased bandwidth.

Visit the documentation to learn more about how to configure Private Service Connect for your Project.

We have introduced in-store endpoints for Quotes, Quote Requests, and Staged Quotes. These endpoints give access only to Quotes associated with specific Stores. In addition, we've added the Create Order in Store from Quote endpoint to the Orders API.

Changes:

• [API] Added in-store endpoints for Quotes, Quote Requests, and Staged Quotes.
• [API] Added Create Order in Store from Quote endpoint.
• [API] Added optional field store to StagedQuote.
• [GraphQL API] Changed the InStore type:
  • Added the stagedQuote, stagedQuotes, quoteRequest, quoteRequests, quote, and quotes fields to the InStore type.
• [GraphQL API] Changed the StagedQuote type:
  • Added the storeRef and store fields to the StagedQuote type.
• [GraphQL API] Changed the Mutation type:
  • Argument storeKey was added to Mutation.createQuote, Mutation.createQuoteRequest, Mutation.createStagedQuote, Mutation.createOrderFromQuote, Mutation.deleteQuote, Mutation.deleteQuoteRequest, Mutation.deleteStagedQuote, Mutation.updateQuote, Mutation.updateQuoteRequest, and Mutation.updateStagedQuote fields.

We have added fields related to PaymentInfo and ReturnInfo on Orders to the Order Search index. You can now perform search requests with these additional Searchable Order fields on all Orders created after 1 June 2024.

Changes:

• [API] Added paymentInfo.payments.custom and paymentInfo.payments.transactions.custom fields to Searchable Order fields.
• [API] Added returnInfo.items.shipmentState, returnInfo.items.paymentState, returnInfo.items.createdAt, and returnInfo.items.lastModifiedAt fields to Searchable Order fields.

After collecting feedback during the beta phase, we have moved Product Tailoring out of beta and into general availability.

Visit the API reference to learn more about how to customize product details for specific brands or regions.

When uploading Product images, the 200 OK response is now returned only after all image sizes have been successfully uploaded to the Content Delivery Network (CDN).
Previously, the response was returned after the successful upload of the small size only. This meant errors were not returned if there were issues uploading the other image sizes.

The new logic enhances the quality of the response because it ensures that all image sizes have been uploaded successfully and will be available on the CDN.

To deliver optimal performance, the change will be released gradually over the next two weeks. Therefore, for some projects, the response will still be returned following the previous logic for a while.

If you wish to learn more about this change, contact your Customer Success Manager.

The limit of Customer Groups you can have in a Project has been increased from 1,000 to 10,000.

This limit can be increased per Project after we review the performance impact. You can find more information in the documentation.

You can now view the client and source that created or updated resources indirectly. This new feature will help improve the auditability of changes that were made to resources through methods such as importing and exporting.

Changes:

• [API] Added the attributedTo property to Client Logging. This field is only present on resources created or modified after 1 April 2024.
• [GraphQL API] Added the following types to the GraphQL schema: Attribution, AttributionSource.
• [GraphQL API] Added field attributedTo to the Initiator type.

A new ManuallySuspended health status has been introduced for Subscriptions.

This status solves an issue where, after fixing a problem that caused the health status to keep switching between Healthy to ConfigurationErrorDeliveryStopped, you needed to delete and recreate a Subscription. Now when the issue is resolved, the Composable Commerce support team can manually change the status to Healthy again, so you no longer need to delete and recreate the Subscription.

A Subscription is changed to the ManuallySuspended status when there is an issue with the Destination queue. The Subscription does not automatically return to a Healthy status. You must contact the Composable Commerce support team to manually change the status to Healthy again.

Changes:

• [API] Added ManuallySuspended health status.

With the new Product Search API, you can create performant storefront search experiences for your products across Stores, Product Selections, and Standalone Prices to enhance product discoverability.

The API includes enhanced query capabilities, including compound expressions, such as AND, OR, NOT, and filter. This functionality enables you to, for instance, filter out specific products from search results or display products based on color criteria, including those with or without a color attribute.

For different types of attributes, prefix search is provided to support partial matches on Products with similar Product keys, for instance.

You can now perform full-text searches on a specific field only, instead of searching through all indexed product data. You didn't have this option before with the Product Projection Search API.

Changes:

• [API] Introduced Product Search API in public beta.
• [API] Added ProductSearchStatus to Project.
• [API] Added ProductSearchIndexingMode to Project.
• [API] Added productsSearch field to SearchIndexingConfiguration.
• [API] Added mode field to Change Product Search Indexing Enabled update action on Project.

After collecting feedback during the beta phase, we have moved Order Edits out of beta and into general availability.

Order Edits differ from direct updates to Orders. You can use Order Edits to make financial changes to the purchase agreement after Order placement. For example, if you need to modify the quantity of a Line Item, thereby affecting the Order total.

We fixed the calculation and rounding of tax subrates on (Custom) Line Items to provide a more consistent experience.

Previously, individual (Custom) Line Item taxes were calculated once based on the sum of the combined subrates. If the calculation of a subrate resulted in a fractional tax amount, it could cause discrepancies between the total price of the (Custom) Line Item(s) and the total price of the Cart.

Now, each tax subrate is calculated and rounded separately. This change ensures that the sum of the tax portions is identical to the (Custom) Line Item's total tax amount. As a result, the total price of all (Custom) Line Items will now match the total price of the Cart.

We've added the taxPortions field to TaxedItemPrice to be consistent and align with the tax information available on TaxedPrice. Now, you can use the taxPortions field to view the individual tax subrate amounts for (Custom) Line Items and shipping-related information on a Cart.

Changes:

• [API] Added taxPortions to TaxedItemPrice.
• [GraphQL API] Changed the TaxedItemPrice type:
  • Added the taxPortions field to the TaxedItemPrice type.

We introduced Product Tailoring in public beta, a new feature designed to enhance your product offerings across different markets. With Product Tailoring, you can customize product details like names, descriptions, slugs, and meta fields for specific brands or countries, using Stores to model these market segments.

By defining tailored product data, you can adapt product information to appeal to different markets and, in turn, increase visibility, customer loyalty, and order volumes.

Changes:

• [API] Added Product Tailoring API.
• [API] Added Product Tailoring Messages.
• [GraphQL API] Added following types to the GraphQL schema: ProductTailoringDraft, ProductTailoring, ProductTailoringCreated, ProductTailoringData, ProductTailoringDeleted, ProductTailoringDescriptionSet, ProductTailoringNameSet, ProductTailoringPublished, ProductTailoringQueryResult, ProductTailoringSlugSet, ProductTailoringUnpublished, ProductTailoringUpdateAction, PublishTailoring, SetProductTailoringDescription, SetProductTailoringMetaAttributes, SetProductTailoringMetaDescription, SetProductTailoringMetaKeywords, SetProductTailoringMetaTitle, SetProductTailoringName, SetProductTailoringSlug, UnpublishTailoring.
• [GraphQL API] Added fields productTailoring and productTailoringList to the InStore type.
• [GraphQL API] Added fields productTailoring and productTailoringList to the Query type.
• [GraphQL API] Added fields createProductTailoring, updateProductTailoring, and deleteProductTailoring to the Mutation type.

You can now use user-defined key values to identify Discount Codes. Previously, you could identify them only by their auto-generated IDs. The enhancement also includes a new update action to set the key value, allowing you to update Discount Code keys efficiently without the need to bulk import Discount Codes with the updated keys.

Additionally, this enhancement also adds support for Messages for Discount Codes. You can subscribe to these Messages for changes when creating, deleting, or setting a key value for a Discount Code.

Changes:

• [API]
  • Added key to DiscountCode and DiscountCodeDraft.
  • Added the Set Key update action to Discount Codes.
  • Added DiscountCodeCreated, DiscountCodeDeleted, DiscountCodeKeySet Messages.
• [GraphQL API]
  • Input field key was added to DiscountCode and DiscountCodeDraft type.
  • Input field setKey was added to DiscountCodeUpdateAction type.
  • Argument key was added to Query.discountCode field and changed Query.discountCode(id) from required to optional.
  • Argument key was added to Mutation.updateDiscountCode field and changed Mutation.updateDiscountCode(id) from required to optional.
  • Argument key was added to Mutation.deleteDiscountCode field that changed Mutation.deleteDiscountCode(id) from required to optional.
  • Added the following types to the GraphQL schema: SetDiscountCodeKey, DiscountCodeCreated, DiscountCodeDeleted, DiscountCodeKeySet.

commercetools Foundry is now available for companies looking to accelerate their time to value with composable commerce. This is a pre-composed solution that comes with a complete set of tailored resources, best practices, expert services, and AI-powered tools designed to simplify and accelerate your adoption of commercetools.

What's included:

• Tailored resources for B2C commerce: a set of resources specifically designed for B2C retail, offering best practice guides for various use cases, along with a Blueprint for B2C Retail, a step-by-step plan that explains how to set up your commerce with commercetools and covers topics from solution architecture overview and project planning to discovery, demo flow, and more.
• AI-powered developer assistant: helping engineering teams with an AI-powered documentation assistant and code generator.
• Store Launchpad for B2C Retail: a quick start for commercetools Projects, ensuring a faster and more efficient go-live.
• Expert services: access to specialized knowledge to accelerate your time to value. Contact your Customer Success Manager to learn more.

After collecting feedback during the beta phase, we have moved AuthenticationMode out of beta. The status of the following features has been changed to general availability:

• authenticationMode property on Customer.
• Set AuthenticationMode update action.

You can now subscribe to Messages that will be triggered when creating and deleting a Cart Discount, and when using the Add Store, Remove Store, and Set Stores actions on Cart Discounts.

Changes:

• [API] Added CartDiscountCreated, CartDiscountDeleted, CartDiscountStoreAdded, CartDiscountStoreRemoved, CartDiscountStoresSet Messages.
• [GraphQL API] Added the following types to the GraphQL schema: CartDiscountCreated, CartDiscountDeleted, CartDiscountStoreAdded, CartDiscountStoreRemoved, CartDiscountStoresSet.

You can now extend the ApprovalFlow resource with Custom Fields. With this, you can add meta-information to your Approval Flow in case it is required for your business logic.

Changes:

• [API] Added optional custom field to the ApprovalFlow type.
• [API] Added Set Custom Type and Set CustomField update actions to Approval Flows.
• [API] Added approval-flow to CustomFieldReferenceValue enum.
• [API] Added approval-flow to ResourceTypeId enum.
• [GraphQL API] Added the following types to the GraphQL schema: SetApprovalFlowCustomField, SetApprovalFlowCustomType.
• [GraphQL API] Changed the ApprovalFlowUpdateAction type:
  • Input field setCustomField was added to ApprovalFlowUpdateAction type
  • Input field setCustomType was added to ApprovalFlowUpdateAction type
• [GraphQL API] Changed the ApprovalFlow type:
  • Added the custom field to the ApprovalFlow type.

After collecting feedback during the beta phase, we have moved Buyer Approval Flows out of beta. The status of the following features has been changed to general availability:

• Approval Rules, which define the conditions under which an Order must go through an approval process.
• Approval Flows, which manage the overall state of the approval process.

These features are only available as part of Composable Commerce for B2B and will be subject to additional terms and pricing. To get access to Composable Commerce for B2B, contact the Composable Commerce support team.

As announced previously in our long-term support plan for Composable Commerce SDKs, Version 1 (v1) of our Java SDK is now deprecated effective 1 January 2024.

The Java v1 SDK will not receive any future updates to fix bugs or security vulnerabilities. If you are currently using the Java v1 SDK, you should migrate to the Java v2 SDK.

You can now enable VPC Service Controls to further enhance security when commercetools Projects access your Google Cloud Pub/Sub and Google Cloud Functions infrastructure.

Enabling VPC Service Controls offers an additional layer of security for Google Cloud services. This layer is independent of Identity and Access Management (IAM) and provides a broader, context-based security perimeter, ensuring that resources are accessible exclusively within the Google Cloud Platform (GCP) infrastructure of commercetools.

We recommend enabling VPC Service Controls for:

• Google Cloud Pub/Sub Subscription Destinations: ensuring that only commercetools Subscription Messages can reach your Pub/Sub resources.
• Google Cloud Functions API Extension Destinations: ensuring that only API Extension requests from commercetools can access your Cloud Function resources.

After collecting feedback during the beta phase, we have moved Store-specific Cart Discounts out of beta. The status of the following features has been changed to general availability:

• manage_cart_discounts:{projectKey}:{storeKey} and view_cart_discounts:{projectKey}:{storeKey} scopes
• stores field on CartDiscount and CartDiscountDraft
• Get, Query, Check, Create, Update, and Delete CartDiscount in Store endpoints
• Add Store, Remove Store, and Set Stores update actions on the Cart Discounts API
• StoreCartDiscountsLimitReached and MaxStoreReferencesReached errors

This feature lets you build Cart Discounts specific to a Store to model, for example, customer-specific or brand-specific cart discounts. To know more about Cart Discounts, see the Cart Discounts API.

After collecting feedback during the beta phase, we have moved Cart total price discount target out of beta. The status of the following features has been changed to general availability:

• CartDiscountTotalPriceTarget type on the Cart Discounts API
• DiscountOnTotalPrice and DiscountedTotalPricePortion types on the Carts API
• discountOnTotalPrice field on Cart and Order

This feature lets you build cart discounts targeting the total price of a cart, for example, get 5$ off your cart total. To know more about cart discounts, see Cart Discounts API.

After collecting feedback during the beta phase, we have moved API Extensions to general availability.

Visit the API reference to learn more about how to extend the behavior of an API with your business logic.

We've reorganized our HTTP API documentation to better accommodate our growing number of APIs. The new structure is tailored to make navigation more intuitive, improving productivity and facilitating a more effective integration and use of our APIs.

A key highlight is the increased visibility of our performance tips. These tips are now readily accessible in the API reference, providing you with valuable insights for optimizing your use of our APIs.

We have added new endpoints across all resources to enable a more efficient way to determine if a particular resource, identified by a key, ID, or Query Parameter, exists. These endpoints are available for all resources, allowing for a consistent and efficient method to verify whether a particular resource is present without retrieving the full data.

As previously announced on 18 July 2023, we changed the type of the previousValue and nextValue fields on the Audit Log Change Type SetNameChange from LocalizedString to String.

In addition, the following update actions now trigger SetLocalizedNameChange instead of SetNameChange:

• Set Name on Discount Codes.
• Set State Name on States.
• Set Name on Stores.

We've also added support for the Set Name update action on Associate Roles, which triggers SetNameChange.

Changes:

• [API] Changed type of previousValue and nextValue fields on SetNameChange from LocalizedString to String.
• [API] Changed the following update actions to trigger SetLocalizedNameChange instead of SetNameChange:
  • Set Name on Discount Codes.
  • Set State Name on States.
  • Set Name on Stores.
• [API] Added support for the Set Name update action on Associate Roles to the Change History API.

You can now subscribe to Messages for email verification and password reset tokens of Customers.

Changes:

• [API] Added CustomerEmailTokenCreated Message.
• [API] Added CustomerPasswordTokenCreated Message.
• [GraphQL API] Added the following types to the GraphQL schema: CustomerEmailTokenCreated, CustomerPasswordTokenCreated.

We changed the type of the state field on OrderFromCartDraft and OrderFromQuoteDraft, as well as the customer field on PaymentDraft, from Reference to ResourceIdentifier. The HTTP API now behaves as documented, and we also aligned the GraphQL API with this behavior.

Changes:

• [API] Changed type of state field on OrderFromCartDraft and OrderFromQuoteDraft from Reference to ResourceIdentifier.
• [API] Changed type of customer field on PaymentDraft from Reference to ResourceIdentifier.
• [GraphQL API] Changed the OrderCartCommand type:
  • OrderCartCommand.state input field type changed from ReferenceInput to ResourceIdentifierInput.
• [GraphQL API] Changed the OrderQuoteCommand type:
  • OrderQuoteCommand.state input field type changed from ReferenceInput to ResourceIdentifierInput.
• [GraphQL API] Changed the SetPaymentCustomer type:
  • SetPaymentCustomer.customer input field type changed from ReferenceInput to ResourceIdentifierInput

After collecting feedback during the beta phase, we have moved the Product Selections mode IndividualExclusion out of beta.

The status of the following features has been changed to general availability:

• variantExclusion field on ProductSelectionAssignment, on AssignedProductSelection, and on AssignedProductReference for Product Selections with IndividualExclusion ProductSelectionMode.
• ProductVariantExclusion type.
• Exclude Product and Set Variant Exclusion update actions.
• Product Selection Product Excluded and Product Selection Variant Exclusion Changed Messages.

To learn more about managing assortments with Product Selections, see Product Selections API.

You can now create Cart Discounts that target the total price of a Cart. With this enhancement, you can configure promotions such as spend 200€ and get 5€ off the cart total. Previously, this discount configuration was not supported.

Changes:

• [API] Added discountOnTotalPrice field to Cart and Order.
• [API] Added DiscountOnTotalPrice and DiscountedTotalPricePortion to the Carts API.
• [API] Added CartDiscountTotalPriceTarget type to the Cart Discounts API.
• [GraphQL API] Added the following types to the GraphQL schema: DiscountOnTotalPrice, DiscountedTotalPricePortion, CartDiscountTotalPriceTarget.
• [GraphQL API] Changed the CartDiscountTargetInput type:
  • Input field totalPrice was added to CartDiscountTargetInput type
• [GraphQL API] Changed the Cart and Order type:
  • Added the discountOnTotalPrice field to the Cart and Order type.

We have released Buyer Approval Flows in public beta. This new feature provides a flexible Order approval process for Business Units. Orders can now be matched to Approval Rules, which determine whether an Order must go through an approval process, and if so, which Associate Roles are needed to approve it. During the approval process, an Approval Flow manages the overall approval state.

With the help of Buyer Approval Flows, you can control each step of the Order approval process, based on the requirements of your organization.

This feature is only available as part of Composable Commerce for B2B and will be subject to additional terms and pricing. To get access to Composable Commerce for B2B, contact the Composable Commerce support team.

Changes:

• [API] Added Approval Rules and Approval Flows APIs.
• [API] Added ApprovalFlowApprovedMessage, ApprovalFlowCompletedMessage, ApprovalFlowCreatedMessage, ApprovalFlowRejectedMessage Messages.
• [API] Added ApprovalRuleApproversSetMessage, ApprovalRuleCreatedMessage, ApprovalRuleDescriptionSetMessage, ApprovalRuleKeySetMessage, ApprovalRuleNameSetMessage, ApprovalRulePredicateSetMessage, ApprovalRuleRequestersSetMessage, ApprovalRuleStatusSetMessage Messages.
• [API] Added CreateApprovalRules, UpdateApprovalRules, and UpdateApprovalFlows Permissions.
• [GraphQL API] Changed the Permission type:
  • Enum values CreateApprovalRules, UpdateApprovalRules and UpdateApprovalFlows were added to enum Permission.

You can now subscribe to Messages for changes to Custom Fields and Types on Customer Groups.

Changes:

• [API] Added CustomerGroupCustomFieldAdded Message.
• [API] Added CustomerGroupCustomFieldChanged Message.
• [API] Added CustomerGroupCustomFieldRemoved Message.
• [API] Added CustomerGroupCustomTypeSet Message.
• [API] Added CustomerGroupCustomTypeRemoved Message.
• [GraphQL API] Added the following types to the GraphQL schema: CustomerGroupCustomFieldAdded, CustomerGroupCustomFieldChanged, CustomerGroupCustomFieldRemoved, CustomerGroupCustomTypeRemoved, CustomerGroupCustomTypeSet.

After collecting feedback during the beta phase, we have moved the Get ProductProjection in Store endpoints out of beta. The status of the following features has been changed to general availability:

• Get ProductProjection in Store by ID
• Get ProductProjection in Store by Key

To learn how Stores can enable filtering of data in Product Projections, see Stores API.

With the addition of shippingInfoExists and forAllShippingInfos functions to Cart Predicates you can now construct predicates that match against ShippingInfo on Carts with multiple Shipping Methods.

Changes:

• [API] Added functions shippingInfoExists and forAllShippingInfos to Cart Predicates.

We have extended the capabilities of Audit Log to help you identify changes made to individual Business Units.

To help you filter Records, we've added the businessUnit query parameter to the Query Records endpoint. This allows you to filter Records by key for three specific resource types: orders, quote-requests, and quotes.

Changes:

• [API] Added query parameter businessUnit to the Query Records endpoint.
• [API] Added businessUnit field to Record.
• [GraphQL API] Added KeyReference type.
• [GraphQL API] Changed the ChangeHistory type:
  • Added businessUnit field to ChangeHistory.
• [GraphQL API] Added businessUnit query parameter for orders, order, quotes, quote, quoteRequests, quoteRequest queries.

You can now subscribe to Messages for Set CustomField, Set Custom Type, Set Address CustomField, and Set Custom Type in Address update actions on Business Units.

Changes:

• [API] Added BusinessUnitCustomFieldAdded Message.
• [API] Added BusinessUnitCustomFieldChanged Message.
• [API] Added BusinessUnitCustomFieldRemoved Message.
• [API] Added BusinessUnitCustomTypeSet Message.
• [API] Added BusinessUnitCustomTypeRemoved Message.
• [API] Added BusinessUnitAddressCustomFieldAdded Message.
• [API] Added BusinessUnitAddressCustomFieldChanged Message.
• [API] Added BusinessUnitAddressCustomFieldRemoved Message.
• [API] Added BusinessUnitAddressCustomTypeSet Message.
• [API] Added BusinessUnitAddressCustomTypeRemoved Message.
• [GraphQL API] Added the following types to the GraphQL schema: BusinessUnitAddressCustomFieldAdded, BusinessUnitAddressCustomFieldChanged, BusinessUnitAddressCustomFieldRemoved, BusinessUnitAddressCustomTypeRemoved, BusinessUnitAddressCustomTypeSet, BusinessUnitCustomFieldAdded, BusinessUnitCustomFieldChanged, BusinessUnitCustomFieldRemoved, BusinessUnitCustomTypeRemoved, BusinessUnitCustomTypeSet.

You can now subscribe to Messages that will be triggered when using Set CustomField, Set Custom Type, Set CustomField in Address, and Set Custom Type in Address actions on Customers.

Changes:

• [API] Added Customer Custom Field Added Message.
• [API] Added Customer Custom Field Changed Message.
• [API] Added Customer Custom Field Removed Message.
• [API] Added Customer Custom Type Set Message.
• [API] Added Customer Custom Type Removed Message.
• [API] Added Customer Address Custom Field Added Message.
• [API] Added Customer Address Custom Field Changed Message.
• [API] Added Customer Address Custom Field Removed Message.
• [API] Added Customer Address Custom Type Set Message.
• [API] Added Customer Address Custom Type Removed Message.
• [GraphQL API] Added the following types to the GraphQL schema: CustomerCustomFieldAdded, CustomerCustomFieldChanged, CustomerCustomFieldRemoved, CustomerCustomTypeSet, CustomerCustomTypeRemoved, CustomerAddressCustomFieldAdded, CustomerAddressCustomFieldChanged, CustomerAddressCustomFieldRemoved, CustomerAddressCustomTypeSet, CustomerAddressCustomTypeRemoved.

You can now create staged values while creating Standalone Prices. Previously, you could only set staged values on existing Standalone Prices after they have been created. Additionally, you can now delete staged values in Standalone Prices. Previously, you could only delete staged values by applying the staged changes to the Standalone Price, or by deleting the respective Standalone Price.

Changes:

• [API] Added staged field to StandalonePriceDraft.
• [API] Added StagedPriceDraft type to the Standalone Prices API.
• [API] Added Remove Staged Values update action to the Standalone Prices API.
• [API] Added StandalonePriceStagedChangesRemoved Message.
• [GraphQL API] Added the following types to the GraphQL schema: StagedPriceDraft, RemoveStagedChanges, StandalonePriceStagedChangesRemoved .
• [GraphQL API] Changed the CreateStandalonePrice type:
  • Added the staged field to the StandalonePriceUpdateAction type.
• [GraphQL API] Changed the StandalonePriceUpdateAction type:
  • Input field removeStagedChanges was added to StandalonePriceUpdateAction type.

After collecting feedback during the beta phase, we have moved Quotes out of beta. The status of the following features has been changed to general availability:

• Creating Quote Requests.
• Creating Staged Quotes with the ability to modify discounts, product quantity, expiration date, and add a note to the Buyer.
• Creating a Quote from a Staged Quote as the offer the Seller makes to the Buyer.
• Creating an Order from a Quote.
• Renegotiation of a Quote between the Buyer and Seller.

In addition, we've also removed the Failed value from the QuoteState and MyQuoteState enums, as it is an unused value that the API does not return.

Changes:

• [API] Removed Failed value from QuoteState enum.
• [API] Removed Failed value from MyQuoteState enum.
• [GraphQL API] Changed the QuoteState type:
  • Enum value Failed was removed from enum QuoteState
• [GraphQL API] Changed the MyQuoteState type:
  • Enum value Failed was removed from enum MyQuoteState

With the addition of perMethodExternalTaxRate on LineItemDraft, you can now set individual external Tax Rates for multiple Shipping Methods within a Line Item. Previously, you had to issue the Set LineItem Tax Rate update action for each Shipping Method.

Changes:

• [API] Added the perMethodExternalTaxRate field to LineItemDraft.
• [API] Added the MethodExternalTaxRateDraft type to the Carts API.
• [GraphQL API] Added the following types to the GraphQL schema: MethodExternalTaxRateDraft, MethodExternalTaxRateDraftOutput.
• [GraphQL API] Changed the LineItemDraftOutput type:
  • Added the perMethodExternalTaxRate field to the LineItemDraftOutput type.
• [GraphQL API] Changed the AddStagedOrderLineItem type:
  • Input field perMethodExternalTaxRate was added to AddStagedOrderLineItem type.
• [GraphQL API] Changed the AddCartLineItem type:
  • Input field perMethodExternalTaxRate was added to AddCartLineItem type.

You can now query QuoteRequest, StagedQuote, and Quote Messages via GraphQL.

In addition, you can now subscribe to Messages about Quote renegotiation requests.

Changes:

• [API] added QuoteRenegotiationRequested Message.
• [GraphQL API] Added the following types to the GraphQL schema: QuoteCreated, QuoteCustomerChanged, QuoteDeleted, QuoteRenegotiationRequested, QuoteRequestCreated, QuoteRequestCustomerChanged, QuoteRequestDeleted, QuoteRequestStateChanged, QuoteRequestStateTransition, QuoteStateChanged, QuoteStateTransition, StagedQuoteCreated, StagedQuoteDeleted, StagedQuoteSellerCommentSet, StagedQuoteStateChanged, StagedQuoteStateTransition, StagedQuoteValidToSet.
• [GraphQL API] Changed the Quote type:
  • Added the customerGroup field to the Quote type.
  • Added the customerGroupRef field to the Quote type.
• [GraphQL API] Changed the QuoteRequest type:
  • Added the customerGroup field to the QuoteRequest type.
  • Added the customerGroupRef field to the QuoteRequest type.

We've introduced GraphQL support for querying Quotes and Quote Requests as an Associate.

Changes:

• [GraphQL API] Added the following types to the GraphQL schema: QuoteQueryInterface, QuoteRequestQueryInterface.
• [GraphQL API] Changed the AsAssociate type:
  • AsAssociate object type now implements QuoteRequestQueryInterface interface
  • AsAssociate object type now implements QuoteQueryInterface interface

With the introduction of the cart field on QuoteRequest, you can now know the Cart from which a Quote was requested.

Changes:

• [API] Added the cart field to QuoteRequest.
• [GraphQL API] Changed the QuoteRequest type:
  • Added the cartRef field to the QuoteRequest type.

We have extended the capabilities of Audit Log to identify changes made by Associates in the context of a Business Unit.

To help you filter Records, we've added the associateId query parameter to the Query Records endpoint. This allows you to filter Records by key for the following resource types: business-units, orders, quote-requests, and quotes.

Changes:

• [API] Added query parameter associateId to the Query Records endpoint.
• [API] Added associate field to the modifiedBy property of Record.
• [API] Updated enum type field of modifiedBy property of Record to include associate option.
• [GraphQL API] Changed the Query type:
  • Added the associateId property to the following fields: businessUnits, businessUnit, orders, order, quotes, quote, quoteRequests, quoteRequest.
• [GraphQL API] Changed the ChangeHistory type:
  • Added associate field to modifiedBy property of ChangeHistory.
• [GraphQL API] Changed the ModifiedByType enum:
  • Added associate option.

After collecting feedback during the beta phase, we have moved Business Units and Associate Roles out of beta. The status of the following features has been changed to general availability:

• Creating, managing, and querying Business Units.
• Linking Carts, Orders, Quote Requests, Staged Quotes, and Quotes to Business Units.
• Creating Associate Roles with granular permissions.
• Assigning Associate Roles to Associates in Business Units.
• Validating that an Associate has sufficient Permissions on a given resource with associate endpoints.

These features are only available as part of Composable Commerce for B2B and will be subject to additional terms and pricing. To get access to Composable Commerce for B2B, contact the Composable Commerce support team.

We introduced the key field on ShoppingListLineItem, ShoppingListLineItemDraft, TextLineItem, and TextLineItemDraft. We also added lineItemKey and textLineItemKey on update actions referencing Shopping List Line Items and Text Line Items. This ensures a consistent experience when working with external identifiers across different entity types in Composable Commerce.

Changes:

• [API] Added key to the following Shopping List types:
  • ShoppingListLineItem, TextLineItem, ShoppingListLineItemDraft, and TextLineItemDraft.
• [API] Added the optional key field on the following update actions on Shopping Lists and My Shopping Lists:
  • Add ShoppingListLineItem and Add TextLineItem.
• [API] Added lineItemKey and made lineItemId optional on the following update actions on ShoppingLists and My Shopping Lists:
  • Change ShoppingListLineItem Quantity, Remove ShoppingListLineItem, Set ShoppingListLineItem Custom Type, Set ShoppingListLineItem CustomField, Set TextLineItem Description, Set TextLineItem Custom Type, Set TextLineItem Custom Field, Change TextLineItem Name, Change TextLineItem Quantity, and Remove TextLine Item.
• [GraphQL API] Changed the SetShoppingListTextLineItemDescription type:
  • SetShoppingListTextLineItemDescription.textLineItemId input field type changed from String! to String
  • Input field textLineItemKey was added to SetShoppingListTextLineItemDescription type

We introduced the taxedPricePortions field on CustomLineItem to add additional support for Carts containing multiple Shipping Methods.

Changes:

• [API] Added the taxedPricePortions field to CustomLineItem.
• [API] Added the shippingKey field to Set CustomLineItem TaxAmount and Set CustomLineItem TaxRate update actions on Carts.
• [API] Added the shippingKey field to Set CustomLineItem TaxAmount and Set CustomLineItem TaxRate update actions on Order Edits.
• [GraphQL API] Changed the CustomLineItem type:
  • Added the taxedPricePortions field to the CustomLineItem type.
• [GraphQL API] Changed the SetCartCustomLineItemTaxAmount type:
  • Added the shippingKey field to the SetCartCustomLineItemTaxAmount type.
• [GraphQL API] Changed the SetCartCustomLineItemTaxRate type:
  • Added the shippingKey field to the SetCartCustomLineItemTaxRate type.
• [GraphQL API] Changed the SetStagedOrderCustomLineItemTaxAmount type:
  • Added the shippingKey field to the SetStagedOrderCustomLineItemTaxAmount type.
• [GraphQL API] Changed the SetStagedOrderCustomLineItemTaxRate type:
  • Added the shippingKey field to the SetStagedOrderCustomLineItemTaxRate type.

As announced before we have now removed the deprecated type field from ProductSelection and its draft, alongside the deprecated ProductSelectionType. The feature has been replaced by ProductSelectionMode kept in the mode field of the ProductSelection.

Changes:

• [API] Removed the type field from Product Selection and ProductSelectionDraft.
• [API] Removed ProductSelectionTypeEnum, IndividualProductSelectionType, and IndividualExclusionProductSelectionType from the Product Selections API.
• [GraphQL API] Removed the type field from the ProductSelection type.
• [GraphQL API] Removed the input field type from the CreateProductSelectionDraft type.

Following the deprecation announcement on 2 May 2023, we have now fully removed the deprecated AssociateRole enum with Buyer and Admin values as well as the roles field on Associate and AssociateDraft.

The deprecated functionality has been replaced by the Associate Roles API. Use the associateRoleAssignments property to assign Associate Roles to Associates.

Changes:

• [API] Removed roles from Associate and AssociateDraft.
• [API] Removed AssociateRole enum with Buyer and Admin values.

You can now subscribe to Messages that will be triggered when using Set CustomField and Set Custom Type actions on Orders.

Changes:

• [API] Added OrderCustomFieldAdded Message.
• [API] Added OrderCustomFieldChanged Message.
• [API] Added OrderCustomFieldRemoved Message.
• [API] Added OrderCustomTypeSet Message.
• [API] Added OrderCustomTypeRemoved Message.
• [GraphQL API] Added the following types to the GraphQL schema: OrderCustomFieldAdded, OrderCustomFieldChanged, OrderCustomFieldRemoved, OrderCustomTypeRemoved, OrderCustomTypeSet.

We introduced the key field on LineItemReturnItem, CustomLineItemReturnItem, and ReturnItemDraft. We also introduced returnItemKey on update actions referencing Return Items for Orders and Order Edits. This ensures a consistent experience when working with external identifiers across different entity types in Composable Commerce.

Changes:

• [API] Added key to the following Order types:
  • LineItemReturnItem, CustomLineItemReturnItem, and ReturnItemDraft.
• [API] Added returnItemKey and made returnItemId optional on the following update actions on Orders:
  • Set ReturnItem Custom Type, Set ReturnItem CustomField, Set ReturnShipmentState, and Set ReturnPaymentState.
• [API] Added returnItemKey and made returnItemId optional on the following update actions on Orders Edits:
  • Set ReturnItem Custom Type, Set ReturnItem CustomField, Set ReturnShipmentState, and Set ReturnPaymentState.
• [GraphQL API] Changed the SetStagedOrderReturnPaymentStateOutput type:
  • Added the returnItemKey field to the SetStagedOrderReturnPaymentStateOutput type.
  • SetStagedOrderReturnPaymentStateOutput.returnItemId field type changed from String! to String
• [GraphQL API] Changed the SetStagedOrderReturnItemCustomType type:
  • Input field returnItemKey was added to SetStagedOrderReturnItemCustomType type
  • SetStagedOrderReturnItemCustomType.returnItemId input field type changed from String! to String

With this enhancement, fixed price Cart Discounts now support money values in high precision to support your business needs. Previously, you could use money values in cent precision only for fixed price Cart Discounts.

Changes:

• [API] Changed the type of money field on CartDiscountValueFixed from CentPrecisionMoney to TypedMoney.
• [API] Changed the type of money field on CartDiscountValueFixedDraft from Money to TypedMoneyDraft.
• [GraphQL API] Added the following types to the GraphQL schema: CartDiscountValueBaseMoneyInput.
• [GraphQL API] Changed the FixedPriceDiscountValue type:
  • FixedPriceDiscountValue.money field type changed from [Money!]! to [BaseMoney!]!
• [GraphQL API] Changed the FixedPriceDiscountValueInput type:
  • FixedPriceDiscountValueInput.money input field type changed from [MoneyInput!]! to [CartDiscountValueBaseMoneyInput!]!

Buyers can now retrieve QuoteRequests by ID or key using the My Quote Requests API.

Changes:

• [API] Added Get QuoteRequest by ID endpoint.
• [API] Added Get QuoteRequest by Key endpoint.

We introduced the customLineItemKey on Order Messages referencing Custom Line Items. The customLineItemKey field is now also available on Transition LineItem State and Import LineItem State update actions on Orders and Order Edits. In addition, we introduced the key field on CustomLineItemImportDraft and LineItemImportDraft. This ensures a consistent experience when working with external identifiers across different entity types in Composable Commerce.

Changes:

• [API] Added customLineItemKey to the following Order Messages:
  • CustomLineItemStateTransition Message, OrderCustomLineItemDiscountSet Message, OrderCustomLineItemQuantityChanged Message, and OrderCustomLineItemRemoved Message.
• [API] Added key to the following Order Import types:
  • CustomLineItemImportDraft and LineItemImportDraft.
• [API] Added customLineItemKey and made customerLineItemId optional on the following update actions on Orders:
  • Transition LineItem State and Import LineItem State.
• [API] Added customLineItemKey and made customerLineItemId optional on the following update actions on Order Edits:
  • Transition LineItem State and Import LineItem State.
• [GraphQL API] Changed the TransitionStagedOrderCustomLineItemStateOutput type:
  • TransitionStagedOrderCustomLineItemStateOutput.customLineItemId field type changed from String! to String

We have extended the capabilities of Audit Log to track changes to Associate Roles. In addition, we introduced new Change Types for Business Units.

To ensure a consistent experience when working with different Change Types across the Change History API, we are adjusting the implementation of SetNameChange and introducing SetLocalizedNameChange.

From 18 October 2023:

• SetNameChange fields previousValue and nextValue will change to type String.
• The following update actions will trigger SetLocalizedNameChange instead of SetNameChange:
  • Set Name on Discount Codes.
  • Set State Name on States.
  • Set Name on Stores.

Changes:

• [API] Added the following Change Types:
  • Associate Roles: ChangeBuyerAssignableChange, SetPermissionsChange.
  • Business Units: AddInheritedAssociateChange, ChangeInheritedAssociateChange, RemoveInheritedAssociateChange.
• [API] Added Label AssociateRoleLabel.
• [API] Added associate-role to ChangeHistoryResourceType enum.
• [GraphQL API] Added the following types to the GraphQL schema: AssociateRoleChangeInput, AssociateRoleLabel.

We updated Client Logging to include information about Associates performing changes. This enhancement is specific to Associates who create or update a Business Unit, Cart, Order, Quote Request, or Quote within the context of associate endpoints. The createdBy and lastModifiedBy properties of affected resources now contain the associate field, referencing the Customer who performed the change. This brings greater visibility into the operations Associates perform within a Business Unit.

• [API] Added associate to CreatedBy.
• [API] Added associate to LastModifiedBy.
• [GraphQL API] Changed the Initiator type:
  • Added the associateRef field to the Initiator type.

You can now subscribe to notifications about changes to Associate Roles.

This feature is only available as part of Composable Commerce for B2B and will be subject to additional terms and pricing. To get access to Composable Commerce for B2B, contact the Composable Commerce support team.

Changes:

• [API] Added the associate-roles type to ChangeSubscriptionResourceTypeId.

We introduced the lineItemKey on Order Messages referencing Line Items. The lineItemKey field is now also available on Transition LineItem State and Import LineItem State update actions on Orders and Order Edits. This ensures a consistent experience when working with external identifiers across different entity types in Composable Commerce.

Changes:

• [API] Added lineItemKey and made lineItemId optional on the following update actions on Orders:
  • Transition LineItem State and Import LineItem State.
• [API] Added lineItemKey and made lineItemId optional on the following update actions on Order Edits:
  • Transition LineItem State and Import LineItem State.
• [API] Added lineItemKey to the following Order Messages:
  • LineItemStateTransition Message, OrderLineItemRemoved Message, OrderLineItemDistributionChannelSet Message, and OrderLineItemDiscountSet Message.
• [GraphQL API] Changed the ImportStagedOrderLineItemState type:
  • ImportStagedOrderLineItemState.lineItemId input field type changed from String! to String
  • Input field lineItemKey was added to ImportStagedOrderLineItemState type

We introduced the customLineItemKey field on update actions referencing Custom Line Items on Carts, Orders, and Order Edits. The customLineItemId field is now optional on the affected update actions. This ensures a consistent experience when working with external identifiers across different entity types in Composable Commerce.

Changes:

• [API] Added customLineItemKey and made customLineItemId optional on the following update actions on Carts:
  • Remove CustomLineItem, Change CustomLineItem Quantity, Set CustomLineItem TaxRate, Set CustomLineItem TaxAmount, Change CustomLineItem Price Mode, Change CustomLineItem Money, Set CustomLineItem ShippingDetails, Apply DeltaToCustomLineItemShippingDetailsTargets, Set CustomLineItem Custom Type, Set CustomLineItem CustomField.
• [API] Added customLineItemKey and made customLineItemId optional on the following update actions on Orders:
  • Set CustomLineItem Custom Type, Set CustomLineItem CustomField, and Set CustomLineItem ShippingDetails.
• [API] Added customLineItemKey and made customLineItemId optional on the following update actions on Order Edits:
  • Set CustomLineItem Custom Type, Set CustomLineItem CustomField, Set CustomLineItem ShippingDetails, Remove CustomLineItem, Change CustomLineItem Quantity, Set CustomLineItem TaxRate, Set CustomLineItem TaxAmount, Change CustomLineItem Money.
• [GraphQL API] Changed the RemoveStagedOrderCustomLineItemOutput type:
  • RemoveStagedOrderCustomLineItemOutput.customLineItemId field type changed from String! to String
  • Added the customLineItemKey field to the RemoveStagedOrderCustomLineItemOutput type.

With the introduction of Store-specific Cart Discounts in public beta, you can now define Cart Discounts that are applicable to specific Stores. Previously, you could only define Cart Discounts that are active across all the Stores in your Project.

You can restrict the permissions of API Clients to view and manage Cart Discounts in a specific Store only. Previously, such permissions could only be managed globally for all Cart Discounts in a Project at the same time. However, the permissions set are not exclusive in the following instances:

• Cart Discounts requiring a Discount Code can be linked to a Discount Code created by any user.
• When using Custom Fields, if any Custom Field references Cart Discounts, all Cart Discounts will be visible.

With this enhancement, the limit for Cart Discounts that do not require a Discount Code has been increased. In addition to the 100 active Cart Discounts that are independent of a Store, you can now have 100 Cart Discounts per Store. Thus, the overall limit is 100 + (100 * number of Stores in a Project).

We introduced the key field on CustomLineItem and CustomLineItemDraft. This ensures a consistent experience when working with external identifiers across different entity types in Composable Commerce.

Changes:

• [API] Added the key field to CustomLineItem and CustomLineItemDraft.
• [API] Added key field to Add CustomLineItem update action on Carts.
• [API] Added key field to Add CustomLineItem update action on Order Edits.
• [GraphQL API] Changed the CustomLineItemDraftOutput type:
  • Added the key field to the CustomLineItemDraftOutput type.
• [GraphQL API] Changed the AddCartCustomLineItem type:
  • Input field key was added to AddCartCustomLineItem type.
• [GraphQL API] Changed the AddStagedOrderCustomLineItem type:
  • Input field key was added to AddStagedOrderCustomLineItem type.
• [GraphQL API] Changed the CustomLineItem type:
  • Added the key field to the CustomLineItem type.
• [GraphQL API] Changed the CustomLineItemDraft type:
  • Input field key was added to CustomLineItemDraft type.

After collecting feedback during the beta phase, we have moved all AWS Regions out of beta and into general availability.

A Business Unit can now contain up to 2000 Associates. This is an increase from the previous limit of 100.

As announced before we have now removed the deprecated values from the type field of ProductVariantSelection. To assign Variants to Product Selections, use the IncludeOnly and IncludeAllExcept types instead.

Changes:

• [API] Removed inclusion and exclusion values from the type field of ProductVariantSelection.
• [GraphQL API] Removed the following types on the GraphQL schema: ProductVariantSelectionExclusion, ProductVariantSelectionInclusion.

We have extended the capabilities of Audit Log to track changes to Business Units. In addition, we introduced new Change Types for Stores, Product Selections, and Quotes.

To help you filter Records, we've added the resourceKey query parameter to the Query Records endpoint. This allows you to filter Records by key for three specific resource types: business-units, products, and stores.

Changes:

• [API] Added the following Change Types:
  • Business Units: AddAssociateChange, ChangeAssociateChange, ChangeAssociateModeChange, ChangeParentUnitChange, ChangeStatusChange, RemoveAssociateChange, SetAddressCustomFieldChange, SetAddressCustomTypeChange, SetContactEmailChange, SetStoreModeChange.
  • Stores: AddProductSelectionChange, ChangeProductSelectionActiveChange, RemoveProductSelectionChange.
  • Product Selections: AddProductChange, SetVariantSelectionChange.
  • Quotes: RequestQuoteRenegotiationChange.
• [API] Added Label BusinessUnitLabel.
• [API] Added query parameter resourceKey to the Query Records endpoint.
• [API] Added key field to resource property of Record.
• [API] Added business-unit to ChangeHistoryResourceType enum.
• [GraphQL API] Added the following types to the GraphQL schema: BusinessUnitChangeInput, ResourceIdentifier, BusinessUnitLabel.
• [GraphQL API] Changed the ResourceTypes type:
  • Added BusinessUnit to the enum ResourceTypes.
• [GraphQL API] Changed the Query type:
  • Added the businessUnits field to the Query type.
  • Added the businessUnit field to the Query type.
  • Added the resourceKey property to the products field.
  • Added the resourceKey property to the stores field.
• [GraphQL API] Changed the ChangeHistory type:
  • Added key field to resource property of ChangeHistory.

The following change was introduced in terms of GraphQL SDL:

After collecting feedback during the beta phase, we have moved the staged and active fields on StandalonePrice out of beta. The status of the following features has been changed to general availability:

• staged and active fields on StandalonePrice.
• active field on StandalonePriceDraft.
• staged field on Change Value update action.
• Apply Staged Changes and Change Active update actions.
• Standalone Price Value Changed, Standalone Price Active Changed, and Standalone Price Staged Changes Applied Messages.

We introduced the lineItemKey field on update actions referencing Line Items on Carts, Orders, and Order Edits. The lineItemId field is now optional on the affected update actions. This ensures a consistent experience when working with external identifiers across different entity types in Composable Commerce.

Changes:

• [API] Added lineItemKey and made lineItemId optional on the following update actions on Carts:
  • Remove LineItem, Change LineItem Quantity, Set LineItem TaxRate, Set LineItem TaxAmount, Set LineItem Price, Set LineItem TotalPrice, Set LineItem DistributionChannel, Set LineItem SupplyChannel, Set LineItem ShippingDetails, Apply DeltaToLineItemShippingDetailsTargets, Set LineItem Custom Type, Set LineItem CustomField, and Set LineItem InventoryMode.
• [API] Added lineItemKey and made lineItemId optional on the following update actions on My Carts:
  • Remove LineItem, Change LineItem Quantity, Set LineItem DistributionChannel, Set LineItem SupplyChannel, Set LineItem ShippingDetails, Apply DeltaToLineItemShippingDetailsTargets, Set LineItem Custom Type, and Set LineItem CustomField.
• [API] Added lineItemKey and made lineItemId optional on the following update actions on Orders:
  • Set LineItem Custom Type, Set LineItem CustomField, and Set LineItem ShippingDetails.
• [API] Added lineItemKey and made lineItemId optional on the following update actions on Order Edits:
  • Set LineItem Custom Type, Set LineItem CustomField, Set LineItem ShippingDetails, Remove LineItem, Change LineItem Quantity, Set LineItem TaxRate, Set LineItem TaxAmount, Set LineItem Price, Set LineItem TotalPrice, and Set LineItem DistributionChannel.
• [GraphQL API] Changed the SetCartLineItemTaxAmount type:
  • SetCartLineItemTaxAmount.lineItemId input field type changed from String! to String
  • Input field lineItemKey was added to SetCartLineItemTaxAmount type
• [GraphQL API] Changed the SetStagedOrderLineItemCustomType type:
  • Input field lineItemKey was added to SetStagedOrderLineItemCustomType type
  • SetStagedOrderLineItemCustomType.lineItemId input field type changed from String! to String

We made a correction to the InventoryEntryCreated type in the GraphQL API. The type of the field inventoryEntry was incorrectly marked as InventoryEntryCreatedContent! instead of InventoryEntry!. This was not in line with the documentation of the InventoryEntryCreated Message and caused the SDKs to not work correctly.

Additionally, we removed the types InventoryEntryCreatedContent and MessageId from the GraphQL schema since they are no longer required.

Changes:

• [GraphQL API] Removed the following types from the GraphQL schema: InventoryEntryCreatedContent, MessageId.
• [GraphQL API] Changed the InventoryEntryCreated type:
  • InventoryEntryCreated.inventoryEntry field type changed from InventoryEntryCreatedContent! to InventoryEntry!

To align with the HTTP API, we now added support for the perMethodTaxRate field on CustomLineItems to the GraphQL API.

Changes:

• [GraphQL API] Added the perMethodTaxRate field to the CustomLineItem type.

You can now update Price tiers on existing Standalone Prices. Before, you had to delete and to recreate the Standalone Price with the new Price tier to achieve this.

Changes:

• [API] Added Add Price Tier, Remove Price Tier, and Set Price Tiers update actions to the Standalone Prices API.
• [API] Added Standalone Price Tier Added, Standalone Price Tier Removed, and Standalone Price Tiers Set Messages.
• [GraphQL API] Added the following types to the GraphQL schema: AddStandalonePriceTier, RemoveStandalonePriceTier, SetStandalonePriceTiers, StandalonePriceTierAdded, StandalonePriceTierRemoved, StandalonePriceTiersSet
• [GraphQL API] Changed the StandalonePriceUpdateAction type:
  • Input field removePriceTier was added to StandalonePriceUpdateAction type
  • Input field addPriceTier was added to StandalonePriceUpdateAction type
  • Input field setPriceTiers was added to StandalonePriceUpdateAction type

The Standalone Price Deleted Message now includes a new field, sku, which helps you identify the associated SKU when you delete a Standalone Price.

Changes:

• [API] Added field sku to Standalone Price Deleted Message.
• [GraphQL API] Changed the StandalonePriceDeleted type:
  • Added the sku field to the StandalonePriceDeleted type.

As announced before we have now removed the variantId, sku and price fields from the Remove Price update action on the Products API. The Price to be removed is now identified by the priceId field, respectively by RemoveProductPrice.priceId in the GraphQL API.

We introduced new update actions on the Standalone Prices API that allow you to modify the start and end dates of a Standalone Price. This feature simplifies the process of maintaining accurate pricing information for your customers. Prior to this enhancement, changing the validity dates required the deletion and recreation of Standalone Prices, a process that was time-consuming and error-prone.

Alongside the new update actions, we also introduced corresponding Subscription Messages to enhance visibility and tracking.

Changes:

• [API] Added Set Valid From, Set Valid Until, and Set Valid From and Until update actions to the Standalone Prices API.
• [API] Added StandalonePriceValidFromSet, StandalonePriceValidUntilSet, and StandalonePriceValidFromAndUntilSet Messages.
• [GraphQL API] Added the following types to the GraphQL schema: SetStandalonePriceValidFrom, SetStandalonePriceValidFromAndUntil, SetStandalonePriceValidUntil, StandalonePriceValidFromAndUntilSet, StandalonePriceValidFromSet, StandalonePriceValidUntilSet.

We introduced the key field on LineItem and LineItemDraft. This ensures a consistent experience when working with external identifiers across different entity types in Composable Commerce.

Changes:

• [GraphQL API] Changed the AddStagedOrderLineItem type:
  • Input field key was added to AddStagedOrderLineItem type
• [GraphQL API] Changed the MyLineItemDraft type:
  • Input field key was added to MyLineItemDraft type
• [GraphQL API] Changed the LineItemDraft type:
  • Input field key was added to LineItemDraft type
• [GraphQL API] Changed the AddCartLineItem type:
  • Input field key was added to AddCartLineItem type
• [GraphQL API] Changed the LineItem type:
  • Added the key field to the LineItem type.
• [GraphQL API] Changed the LineItemDraftOutput type:
  • Added the key field to the LineItemDraftOutput type.
• [GraphQL API] Changed the AddMyCartLineItem type:
  • Input field key was added to AddMyCartLineItem type

Business Units and Associate Roles can now be used as ReferenceTypes on Custom Fields. The new associate-role and business-unit values are supported on all customizable data types providing full flexibility in extending B2B features.

Changes:

• [API] Added business-unit and associate-role to CustomFieldReferenceValue.

We are announcing that Confluent Cloud is now supported as a Subscription destination.

With the introduction of Confluent Cloud support, customers can now natively use Apache Kafka across their preferred cloud platforms, whether it's Google Cloud, Azure, or AWS. This integration not only eliminates the necessity for intermediary gateways to consume messages from Kafka but also reduces the associated resources and costs.

Changes:

• [API] Added ConfluentCloudDestination to Subscriptions.
• [GraphQL API] Added the following types to the GraphQL schema: ConfluentCloudDestination, ConfluentCloudDestinationInput
• [GraphQL API] Changed the DestinationInput type:
  • Input field ConfluentCloud was added to DestinationInput type

We introduced GraphQL support for creating Associates using My Business Units. This allows Customers with the UpdateAssociates Permission to create a new Associate, assigning them roles specific to the given Business Unit.

Changes:

• [GraphQL API] Added the following types to the GraphQL schema: SignUpInMyBusinessUnitDraft.
• [GraphQL API] Changed the Mutation type:
  • Added the signUpInMyBusinessUnit field to the Mutation type.

We introduced the key field on Parcel and ParcelDraft. This ensures a consistent experience when working with external identifiers across different entity types in Composable Commerce.

Changes:

• [API] Added the key field to Parcel and ParcelDraft.
• [API] Added the parcelKey field and changed the parcelId field to be optional on the following Order and StagedOrderUpdateAction update actions:
  • Set Parcel Custom Type
  • Set Parcel Custom Field
  • Remove Parcel from Delivery
  • Set Parcel Measurements
  • Set Parcel Tracking Data
  • Set Parcel Items
• [API] Added the parcelKey field to the Add Parcel update action on Order and StagedOrderUpdateAction.
• [GraphQL API] Changed the Parcel type:
  • Added the key field to the Parcel type.
• [GraphQL API] Changed the ParcelDraft type:
  • Input field key was added to ParcelDraft type
• [GraphQL API] Changed the SetStagedOrderParcelCustomTypeOutput type:
  • Added the parcelKey field to the SetStagedOrderParcelCustomTypeOutput type.
  • SetStagedOrderParcelCustomTypeOutput.parcelId field type changed from String! to String
• [GraphQL API] Changed the SetOrderParcelMeasurements type:
  • SetOrderParcelMeasurements.parcelId input field type changed from String! to String
  • Input field parcelKey was added to SetOrderParcelMeasurements type
• [GraphQL API] Changed the SetStagedOrderParcelCustomType type:
  • SetStagedOrderParcelCustomType.parcelId input field type changed from String! to String
  • Input field parcelKey was added to SetStagedOrderParcelCustomType type
• [GraphQL API] Changed the SetStagedOrderParcelTrackingData type:
  • SetStagedOrderParcelTrackingData.parcelId input field type changed from String! to String
  • Input field parcelKey was added to SetStagedOrderParcelTrackingData type
• [GraphQL API] Changed the SetStagedOrderParcelCustomField type:
  • SetStagedOrderParcelCustomField.parcelId input field type changed from String! to String
  • Input field parcelKey was added to SetStagedOrderParcelCustomField type
• [GraphQL API] Changed the SetStagedOrderParcelMeasurements type:
  • Input field parcelKey was added to SetStagedOrderParcelMeasurements type
  • SetStagedOrderParcelMeasurements.parcelId input field type changed from String! to String
• [GraphQL API] Changed the AddOrderParcelToDelivery type:
  • Input field parcelKey was added to AddOrderParcelToDelivery type
• [GraphQL API] Changed the SetStagedOrderParcelTrackingDataOutput type:
  • SetStagedOrderParcelTrackingDataOutput.parcelId field type changed from String! to String
  • Added the parcelKey field to the SetStagedOrderParcelTrackingDataOutput type.
• [GraphQL API] Changed the SetStagedOrderParcelMeasurementsOutput type:
  • SetStagedOrderParcelMeasurementsOutput.parcelId field type changed from String! to String
  • Added the parcelKey field to the SetStagedOrderParcelMeasurementsOutput type.
• [GraphQL API] Changed the SetOrderParcelTrackingData type:
  • SetOrderParcelTrackingData.parcelId input field type changed from String! to String
  • Input field parcelKey was added to SetOrderParcelTrackingData type
• [GraphQL API] Changed the RemoveOrderParcelFromDelivery type:
  • RemoveOrderParcelFromDelivery.parcelId input field type changed from String! to String
  • Input field parcelKey was added to RemoveOrderParcelFromDelivery type
• [GraphQL API] Changed the ParcelData type:
  • Added the key field to the ParcelData type.
• [GraphQL API] Changed the AddStagedOrderParcelToDelivery type:
  • Input field parcelKey was added to AddStagedOrderParcelToDelivery type
• [GraphQL API] Changed the SetStagedOrderParcelItems type:
  • SetStagedOrderParcelItems.parcelId input field type changed from String! to String
  • Input field parcelKey was added to SetStagedOrderParcelItems type
• [GraphQL API] Changed the SetOrderParcelCustomType type:
  • SetOrderParcelCustomType.parcelId input field type changed from String! to String
  • Input field parcelKey was added to SetOrderParcelCustomType type
• [GraphQL API] Changed the ParcelDataDraftType type:
  • Input field key was added to ParcelDataDraftType type
• [GraphQL API] Changed the SetStagedOrderParcelItemsOutput type:
  • SetStagedOrderParcelItemsOutput.parcelId field type changed from String! to String
  • Added the parcelKey field to the SetStagedOrderParcelItemsOutput type.
• [GraphQL API] Changed the RemoveStagedOrderParcelFromDeliveryOutput type:
  • Added the parcelKey field to the RemoveStagedOrderParcelFromDeliveryOutput type.
  • RemoveStagedOrderParcelFromDeliveryOutput.parcelId field type changed from String! to String
• [GraphQL API] Changed the SetOrderParcelItems type:
  • Input field parcelKey was added to SetOrderParcelItems type
  • SetOrderParcelItems.parcelId input field type changed from String! to String
• [GraphQL API] Changed the SetOrderParcelCustomField type:
  • Input field parcelKey was added to SetOrderParcelCustomField type
  • SetOrderParcelCustomField.parcelId input field type changed from String! to String
• [GraphQL API] Changed the RemoveStagedOrderParcelFromDelivery type:
  • RemoveStagedOrderParcelFromDelivery.parcelId input field type changed from String! to String
  • Input field parcelKey was added to RemoveStagedOrderParcelFromDelivery type
• [GraphQL API] Changed the SetStagedOrderParcelCustomFieldOutput type:
  • SetStagedOrderParcelCustomFieldOutput.parcelId field type changed from String! to String
  • Added the parcelKey field to the SetStagedOrderParcelCustomFieldOutput type.
• [GraphQL API] Changed the AddStagedOrderParcelToDeliveryOutput type:
  • Added the parcelKey field to the AddStagedOrderParcelToDeliveryOutput type.

A new state RenegotiationAddressed has been added to QuoteState. With this new state, Sellers can see Quotes where renegotiations requested by the respective buyer have been addressed.

Changes:

• [API] Added RenegotiationAddressed field to QuoteState.
• [GraphQL API] Changed the QuoteState type:
  • Enum value RenegotiationAddressed was added to enum QuoteState

You can now change the InventoryMode of an existing LineItem by using the Set LineItem InventoryMode update action on the general endpoint. The InventoryMode could previously only be set when creating new Line Items.

Changes:

• [API] Added Set LineItem InventoryMode update action to the Carts API.
• [GraphQL API] Added the following types to the GraphQL schema: SetCartLineItemInventoryMode.
• [GraphQL API] Changed the CartUpdateAction type:
  • Input field setLineItemInventoryMode was added to CartUpdateAction type

After collecting feedback during the beta phase, we have moved countries on Stores out of beta. The status of the following features has been changed to general availability:

• Adding a country to a Store.
• Removing a country from a Store.
• Setting the countries on a Store.
• The StoreCountriesChanged Message.

Visit the API reference to learn more about how countries on Stores can enable filtering prices in Product Projections and Cart, Order, and Shopping List Line Items.

We've added the MoneyOverflow error code to help identify instances when a Money operation has failed due to an integer overflow.

Both centAmount (applicable to all money types), as well as preciseAmount (for high precision money types) are represented as 64-bit integers. If a Money operation results in either object exceeding the 64-bit limit, the API returns a 400 Bad Request with the MoneyOverflow error code.

Changes:

• [API] Added the MoneyOverflow error code.

After collecting feedback during the beta phase, we have moved Attribute Groups out of beta. The status of the following features has been changed to general availability:

• Querying and managing Attribute Groups.

Attribute Groups let you organize Attribute Definitions by providing a list of references to Product Attributes. Learn more by visiting our documentation page.

After collecting feedback during the beta phase, we have moved Direct Discounts out of beta. With Direct Discounts you can add a fixed or percentage discount to a single Cart.

The status of the following features has been changed to general availability:

• Set Direct Discounts on Order Edits

• Set Direct Discounts on Carts

We introduced functionality to enable the reassignment of B2B Quotes and Quote Requests. This enhancement ensures that the Customer on a Quote or Quote Request can be updated in the event that they leave their Business Unit. The new Change Customer update action is available on Quote and Quote Request.

The new ReassignMyQuotes and ReassignOthersQuotes Permissions determine the ability to reassign a Quote within the context of a Business Unit. To enhance visibility and tracking, we have introduced two new Messages: QuoteRequestCustomerChanged and QuoteCustomerChanged. These Messages are triggered whenever a Quote or Quote Request's Customer is modified.

These enhancements improve the management of B2B Quotes within Composable Commerce, ensuring that Quotes and Quote Requests remain connected to the appropriate Associates even during organizational changes.

Changes:

• [API] Added the Change Customer update action to Quote.
• [API] Added the Change Customer update action to Quote Requests.
• [API] Added ReassignMyQuotes and ReassignOthersQuotes Permissions.
• [API] Added QuoteRequestCustomerChanged and QuoteCustomerChanged Messages.
• [GraphQL API] Added the following types to the GraphQL schema: ChangeQuoteCustomer, ChangeQuoteRequestCustomer.
• [GraphQL API] Changed the Permission type:
  • Enum value ReassignOthersQuotes was added to enum Permission
  • Enum value ReassignMyQuotes was added to enum Permission
• [GraphQL API] Changed the QuoteRequestUpdateAction type:
  • Input field changeCustomer was added to QuoteRequestUpdateAction type
• [GraphQL API] Changed the QuoteUpdateAction type:
  • Input field changeCustomer was added to QuoteUpdateAction type

You can now replicate Carts in a given Business Unit using the Associate Carts endpoint.

• [API] Added Replicate Cart in Business Unit endpoint.
• [GraphQL API] Changed the Mutation type:
  • Argument asAssociate was added to Mutation.replicateCart field

We have added support for external tax rates and tax amounts on multiple Shipping Methods. You can now target individual Shipping Methods by including a shippingKey when using the Set ShippingMethod TaxAmount and Set ShippingMethod TaxRate update actions for Carts and Order Edits.

Changes:

• [API] Added the shippingKey field to the following update actions on Carts:

  • Set ShippingMethod TaxAmount
  • Set ShippingMethod TaxRate

• [API] Added the shippingKey field to the following update actions on Order Edits:

  • Set ShippingMethod TaxAmount
  • Set ShippingMethod TaxRate

• [GraphQL API] Changed the SetStagedOrderShippingMethodTaxRateOutput type:

  • Added the shippingKey field to the SetStagedOrderShippingMethodTaxRateOutput type.

• [GraphQL API] Changed the SetStagedOrderShippingMethodTaxAmount type:

  • Input field shippingKey was added to SetStagedOrderShippingMethodTaxAmount type

• [GraphQL API] Changed the SetCartShippingMethodTaxRate type:

  • Input field shippingKey was added to SetCartShippingMethodTaxRate type

• [GraphQL API] Changed the SetStagedOrderShippingMethodTaxRate type:

  • Input field shippingKey was added to SetStagedOrderShippingMethodTaxRate type

• [GraphQL API] Changed the SetCartShippingMethodTaxAmount type:

  • Input field shippingKey was added to SetCartShippingMethodTaxAmount type

• [GraphQL API] Changed the SetStagedOrderShippingMethodTaxAmountOutput type:

  • Added the shippingKey field to the SetStagedOrderShippingMethodTaxAmountOutput type.

We have added support for New Relic to Composable Commerce SDKs.

New Relic is an observability platform which monitors your application's performance. This integration helps you analyze your application to identify potential improvements for performance and user experience.

With this update, you can:

• Trace and profile application performance directly from the SDK.
• View and analyze your application's performance.
• Get real-time insights and alerts about your application's performance and issues.

New Relic is currently supported by the latest versions of the Java SDK, TypeScript SDK, PHP SDK, and .NET SDK.

commercetools Composable Commerce is now available in China on AWS Ningxia in addition to our existing Regions in North America, Europe, and Australia. The China Region is available as part of Composable Commerce for China. Please reach out to your commercetools contact person to learn more.

Find the URLs to the commercetools Composable Commerce API here. Log in here.

When configuring a Project in the China Region, note that external links (for example, URLs used for images, external OAuth, and API Extensions) may be blocked due to firewall restrictions.

The variantId, sku and price fields are now deprecated in the Remove Price update action on Products. Please use priceId instead. For the GraphQL API, please use RemoveProductPrice.priceId instead.

Changes:

• [GraphQL API] Changed the RemoveProductPrice type:
  • RemoveProductPrice.variantId is deprecated
  • RemoveProductPrice.sku is deprecated
  • RemoveProductPrice.price is deprecated

We introduced the key field on Delivery and DeliveryDraft. This ensures a consistent experience when working with external identifiers across different entity types in Composable Commerce.

Changes:

• [API] Added the key field to Delivery and DeliveryDraft.

• [API] Added the deliveryKey field to the following update actions on Orders:

  • Add Delivery
  • Add Parcel
  • Remove Delivery
  • Set Delivery Address
  • Set Delivery Address CustomField
  • Set Delivery Address Custom Type
  • Set Delivery CustomField
  • Set Delivery Custom Type
  • Set Delivery Items

• [API] Added the deliveryKey field to the following update actions on Order Edits:

  • Add Delivery
  • Add Parcel
  • Remove Delivery
  • Set Delivery Address
  • Set Delivery Address CustomField
  • Set Delivery Address Custom Type
  • Set Delivery CustomField
  • Set Delivery Custom Type
  • Set Delivery Items

• [API] Changed the deliveryId field to be optional on the following update actions on Orders:

  • Add Parcel
  • Remove Delivery
  • Set Delivery Address
  • Set Delivery Address CustomField
  • Set Delivery Address Custom Type
  • Set Delivery CustomField
  • Set Delivery Custom Type
  • Set Delivery Items

• [API] Changed the deliveryId field to be optional on the following update actions on Order Edits:

  • Add Parcel
  • Remove Delivery
  • Set Delivery Address
  • Set Delivery Address CustomField
  • Set Delivery Address Custom Type
  • Set Delivery CustomField
  • Set Delivery Custom Type
  • Set Delivery Items

• [GraphQL API] Changed the SetStagedOrderDeliveryCustomField type:

  • Input field deliveryKey was added to SetStagedOrderDeliveryCustomField type
  • SetStagedOrderDeliveryCustomField.deliveryId input field type changed from String! to String

• [GraphQL API] Changed the AddStagedOrderDeliveryOutput type:

  • Added the deliveryKey field to the AddStagedOrderDeliveryOutput type.

• [GraphQL API] Changed the SetStagedOrderDeliveryAddressOutput type:

  • SetStagedOrderDeliveryAddressOutput.deliveryId field type changed from String! to String
  • Added the deliveryKey field to the SetStagedOrderDeliveryAddressOutput type.

• [GraphQL API] Changed the Delivery type:

  • Added the key field to the Delivery type.

• [GraphQL API] Changed the SetStagedOrderDeliveryAddressCustomType type:

  • Input field deliveryKey was added to SetStagedOrderDeliveryAddressCustomType type
  • SetStagedOrderDeliveryAddressCustomType.deliveryId input field type changed from String! to String

• [GraphQL API] Changed the AddStagedOrderDelivery type:

  • Input field deliveryKey was added to AddStagedOrderDelivery type

• [GraphQL API] Changed the SetStagedOrderDeliveryItemsOutput type:

  • Added the deliveryKey field to the SetStagedOrderDeliveryItemsOutput type.
  • SetStagedOrderDeliveryItemsOutput.deliveryId field type changed from String! to String

• [GraphQL API] Changed the SetStagedOrderDeliveryAddress type:

  • Input field deliveryKey was added to SetStagedOrderDeliveryAddress type
  • SetStagedOrderDeliveryAddress.deliveryId input field type changed from String! to String

• [GraphQL API] Changed the SetStagedOrderDeliveryAddressCustomTypeOutput type:

  • Added the deliveryKey field to the SetStagedOrderDeliveryAddressCustomTypeOutput type.
  • SetStagedOrderDeliveryAddressCustomTypeOutput.deliveryId field type changed from String! to String

• [GraphQL API] Changed the SetOrderDeliveryAddressCustomField type:

  • SetOrderDeliveryAddressCustomField.deliveryId input field type changed from String! to String
  • Input field deliveryKey was added to SetOrderDeliveryAddressCustomField type

• [GraphQL API] Changed the SetStagedOrderDeliveryCustomType type:

  • SetStagedOrderDeliveryCustomType.deliveryId input field type changed from String! to String
  • Input field deliveryKey was added to SetStagedOrderDeliveryCustomType type

• [GraphQL API] Changed the DeliveryDraft type:

  • Input field key was added to DeliveryDraft type

• [GraphQL API] Changed the RemoveStagedOrderDeliveryOutput type:

  • Added the deliveryKey field to the RemoveStagedOrderDeliveryOutput type.
  • RemoveStagedOrderDeliveryOutput.deliveryId field type changed from String! to String

• [GraphQL API] Changed the RemoveStagedOrderDelivery type:

  • RemoveStagedOrderDelivery.deliveryId input field type changed from String! to String
  • Input field deliveryKey was added to RemoveStagedOrderDelivery type

• [GraphQL API] Changed the AddOrderDelivery type:

  • Input field deliveryKey was added to AddOrderDelivery type

• [GraphQL API] Changed the SetStagedOrderDeliveryCustomFieldOutput type:

  • Added the deliveryKey field to the SetStagedOrderDeliveryCustomFieldOutput type.
  • SetStagedOrderDeliveryCustomFieldOutput.deliveryId field type changed from String! to String

• [GraphQL API] Changed the SetStagedOrderDeliveryAddressCustomFieldOutput type:

  • SetStagedOrderDeliveryAddressCustomFieldOutput.deliveryId field type changed from String! to String
  • Added the deliveryKey field to the SetStagedOrderDeliveryAddressCustomFieldOutput type.

• [GraphQL API] Changed the AddStagedOrderParcelToDelivery type:

  • Input field deliveryKey was added to AddStagedOrderParcelToDelivery type
  • AddStagedOrderParcelToDelivery.deliveryId input field type changed from String! to String

• [GraphQL API] Changed the SetOrderDeliveryAddress type:

  • SetOrderDeliveryAddress.deliveryId input field type changed from String! to String
  • Input field deliveryKey was added to SetOrderDeliveryAddress type

• [GraphQL API] Changed the AddOrderParcelToDelivery type:

  • AddOrderParcelToDelivery.deliveryId input field type changed from String! to String
  • Input field deliveryKey was added to AddOrderParcelToDelivery type

• [GraphQL API] Changed the RemoveOrderDelivery type:

  • RemoveOrderDelivery.deliveryId input field type changed from String! to String
  • Input field deliveryKey was added to RemoveOrderDelivery type

• [GraphQL API] Changed the SetOrderDeliveryCustomType type:

  • Input field deliveryKey was added to SetOrderDeliveryCustomType type
  • SetOrderDeliveryCustomType.deliveryId input field type changed from String! to String

• [GraphQL API] Changed the SetOrderDeliveryCustomField type:

  • SetOrderDeliveryCustomField.deliveryId input field type changed from String! to String
  • Input field deliveryKey was added to SetOrderDeliveryCustomField type

• [GraphQL API] Changed the SetStagedOrderDeliveryItems type:

  • SetStagedOrderDeliveryItems.deliveryId input field type changed from String! to String
  • Input field deliveryKey was added to SetStagedOrderDeliveryItems type

• [GraphQL API] Changed the SetStagedOrderDeliveryCustomTypeOutput type:

  • Added the deliveryKey field to the SetStagedOrderDeliveryCustomTypeOutput type.
  • SetStagedOrderDeliveryCustomTypeOutput.deliveryId field type changed from String! to String

• [GraphQL API] Changed the SetOrderDeliveryAddressCustomType type:

  • Input field deliveryKey was added to SetOrderDeliveryAddressCustomType type
  • SetOrderDeliveryAddressCustomType.deliveryId input field type changed from String! to String

• [GraphQL API] Changed the SetStagedOrderDeliveryAddressCustomField type:

  • SetStagedOrderDeliveryAddressCustomField.deliveryId input field type changed from String! to String
  • Input field deliveryKey was added to SetStagedOrderDeliveryAddressCustomField type

• [GraphQL API] Changed the AddStagedOrderParcelToDeliveryOutput type:

  • Added the deliveryKey field to the AddStagedOrderParcelToDeliveryOutput type.
  • AddStagedOrderParcelToDeliveryOutput.deliveryId field type changed from String! to String

• [GraphQL API] Changed the SetOrderDeliveryItems type:

  • SetOrderDeliveryItems.deliveryId input field type changed from String! to String
  • Input field deliveryKey was added to SetOrderDeliveryItems type

We added support for locale-based Product Projection to the product and products queries on the GraphQL API. With this projection, your response contains the translation on Products (also in a Store) you have specified in your query only. All other locales are filtered out from the product information. Furthermore, the projection can also be applied to Products expanded on Reference Type Attributes.

Changes:

• [GraphQL API] Changed the Query type:
  • Argument localeProjection was added to Query.products field
  • Argument localeProjection was added to Query.product field
  • Argument projectExpandedProducts was added to Query.productProjectionSearch field
  • Argument projectExpandedProducts was added to Query.product field
  • Argument projectExpandedProducts was added to Query.products field
• [GraphQL API] Changed the InStore type:
  • Arguments localeProjection was added to InStore.product field
  • Argument projectExpandedProducts was added to InStore.product field

We have made the fields BusinessUnit.associateMode, Associate.associateRoleAssignments, and AssociateRoleAssignment.inheritance mandatory in responses. They were previously optional during the closed beta period.

Changes:

• [GraphQL API] Changed the BusinessUnit type:
  • BusinessUnit.associateMode field type changed from BusinessUnitAssociateMode to BusinessUnitAssociateMode!
• [GraphQL API] Changed the Associate type:
  • Associate.associateRoleAssignments field type changed from [AssociateRoleAssignment!] to [AssociateRoleAssignment!]!
• [GraphQL API] Changed the AssociateRoleAssignment type:
  • AssociateRoleAssignment.inheritance field type changed from AssociateInheritanceMode to AssociateInheritanceMode!

We introduced the error code AssociateMissingPermissionError for Associate Roles. This error code helps to identify when an Associate is missing a specific Permission on a B2B resource.

Changes:

• [API] Added AssociateMissingPermissionError.

The GraphQL API now supports querying inherited Stores of a Business Unit. Visit the API reference for more information on additional GraphQL fields available on Business Units.

Changes:

• [GraphQL API] Changed the BusinessUnit type:
  • Added the inheritedStores field to the BusinessUnit type.

The new Associate Roles API provides B2B customers with the flexibility to define and manage the permissions of their Associates. The feature allows the configuration of granular permissions that provide controlled access to Business Units, Carts, Orders, Quotes, and Quote Requests. Additionally, roles can be inherited from a parent Business Unit by its children.

This feature replaces the less flexible AssociateRole enum with Buyer and Admin values. This type alongside the roles field on Associate and AssociateDraft is now deprecated and will be completely removed on 02 August 2023.

In addition to the Associate Roles API, a new set of associate endpoints can be used to validate that an Associate has sufficient permissions on a given resource. These endpoints are available for Business Units, Carts, Orders, Quotes, and Quote Requests and perform permission evaluation checks based on an associateId.

These features are part of Composable Commerce for B2B and will be subject to additional terms and pricing.

Changes:

• [API] Added Associate Roles API.
• [API] Added Associate Carts, Associate Orders, Associate Quote Requests, Associate Quotes, and Associate BusinessUnit endpoints.
• [API] Added BusinessUnitAssociateMode, AssociateRoleInheritanceMode, AssociateRoleAssignment, and AssociateRoleAssignmentDraft, InheritedAssociate, and InheritedAssociateRoleAssignment types to BusinessUnit.
• [API] Added inheritedAssociates and associateMode fields to BusinessUnit.
• [API] Added associateMode fields to BusinessUnitDraft.
• [API] Added associateRoleAssignments field to Associate and AssociateDraft.
• [API] AddedassociateRoleAssignments to MyBusinessUnitAssociateDraft.
• [API] Deprecated AssociateRole enum with Admin and Buyer values.
• [API] Deprecated roles and inheritedAssociates field on Associate and AssociateDraft.
• [API] Added Associate Role Messages.
• [API] Added BusinessUnitAssociateModeChanged Message.
• [API] Added myBusinessUnitAssociateRoleOnCreation to BusinessUnitConfiguration in Project settings.
• [GraphQL API] Added the following types to the GraphQL schema: AddAssociateRolePermission, AsAssociate, AsAssociateArgument, AssociateInheritanceMode, AssociateRole, AssociateRoleAssignment, AssociateRoleAssignmentDraft, AssociateRoleBuyerAssignableChanged, AssociateRoleCreated, AssociateRoleDeleted, AssociateRoleDraft, AssociateRoleNameSet, AssociateRolePermissionAdded, AssociateRolePermissionRemoved, AssociateRolePermissionsSet, AssociateRoleQueryResult, AssociateRoleUpdateAction, BusinessUnitAssociateMode, BusinessUnitAssociateModeChanged, ChangeAssociateRoleBuyerAssignable, ChangeBusinessUnitAssociateMode, InheritedAssociate, InheritedAssociateRoleAssignment, Permission, RemoveAssociateRolePermission, SetAssociateRoleCustomField, SetAssociateRoleCustomType, SetAssociateRoleName, SetAssociateRolePermissions, SetProjectSettingsMyBusinessUnitAssociateRoleOnCreation.
• [GraphQL API] Changed the BusinessUnitDraft type:
  • Input field associateMode was added to BusinessUnitDraft type
• [GraphQL API] Changed the BusinessUnit type:
  • Added the inheritedAssociates field to the BusinessUnit type.
  • Added the associateMode field to the BusinessUnit type.
• [GraphQL API] Changed the Associate type:
  • Added the associateRoleAssignments field to the Associate type.
  • Field roles was deprecated in Associate type
• [GraphQL API] Changed the AssociateDraft type:
  • Input field associateRoleAssignments was added to AssociateDraft type
  • Input field roles was deprecated in AssociateDraft type
• [GraphQL API] Changed the BusinessUnitConfiguration type:
  • Added the myBusinessUnitAssociateRoleOnCreation field to the BusinessUnitConfiguration type.
  • Added the myBusinessUnitAssociateRoleOnCreationRef field to the BusinessUnitConfiguration type.
• [GraphQL API] SimpleAssociateRole type was deprecated
• [GraphQL API] Changed the Query type:
  • Added the asAssociate field to the Query type.
  • Added the associateRole field to the Query type.
  • Added the associateRoles field to the Query type.
• [GraphQL API] Changed the Mutation type:
  • Argument asAssociate was added to Mutation.updateBusinessUnit field
  • Added the updateAssociateRole field to the Mutation type.
  • Argument asAssociate was added to Mutation.createOrderFromCart field
  • Argument asAssociate was added to Mutation.deleteCart field
  • Argument asAssociate was added to Mutation.createBusinessUnit field
  • Argument asAssociate was added to Mutation.updateQuoteRequest field
  • Argument asAssociate was added to Mutation.createOrderFromQuote field
  • Argument asAssociate was added to Mutation.createCart field
  • Argument asAssociate was added to Mutation.updateOrder field
  • Added the deleteAssociateRole field to the Mutation type.
  • Argument asAssociate was added to Mutation.updateQuote field
  • Argument asAssociate was added to Mutation.createQuoteRequest field
  • Added the createAssociateRole field to the Mutation type.
  • Argument asAssociate was added to Mutation.updateCart field
• [GraphQL API] Changed the ProjectSettingsUpdateAction type:
  • Input field setMyBusinessUnitAssociateRoleOnCreation was added to ProjectSettingsUpdateAction type
• [GraphQL API] Changed the BusinessUnitUpdateAction type:
  • Input field changeAssociateMode was added to BusinessUnitUpdateAction type

After collecting feedback during the beta phase, we have moved Product Selections out of beta. The status of the following features has been changed to general availability:

• Querying and managing Product Selections.
• Adding and removing Products from Product Selections.

Product Selections can be used to manage individual assortments for different sales channels and Stores. Learn more by visiting our documentation page.

We introduced a new type ProductSelectionMode to replace ProductSelectionType. The functionality of Individual and IndividualExclusion Product Selections remains the same. We adjusted the naming of the type and the enums to ensure a consistent experience when working with the Composable Commerce APIs.

Instead of the previous individual and individualExclusion enums defined by the type field on ProductSelection, you can now use the mode field with the values Individual and IndividualExclusion. The type field, alongside ProductSelectionType is now deprecated and will be completely removed on 18 July 2023.

We also aligned the behavior of ProductSelectionCreated Message with other similar Messages generated by resource creation. The Message now includes the entire ProductSelection object in the payload, instead of a subset of the fields.

Changes:

• [API] Added the mode field to ProductSelection and ProductSelectionDraft.
• [API] Deprecated ProductSelectionTypeEnum, IndividualProductSelectionType, IndividualExclusionProductSelectionType from ProductSelection.
• [API] Deprecated the type field from ProductSelection and ProductSelectionDraft.
• [API] Changed the type of productSelection field on ProductSelectionCreated Message from ProductSelectionType to ProductSelection.
• [GraphQL API] Removed the following types from the GraphQL schema: ProductSelectionType, IndividualExclusionProductSelectionCreatedPayload, IndividualProductSelectionCreatedPayload, ProductSelectionCreatedPayload.
• [GraphQL API] Changed the ProductSelection type:
  • Removed the type field from the ProductSelection type.
  • Added the mode field to the ProductSelection type.
• [GraphQL API] Changed the CreateProductSelectionDraft type:
  • Input field type was removed from CreateProductSelectionDraft type
  • Input field mode was added to CreateProductSelectionDraft type
• [GraphQL API] Changed the ProductSelectionCreated type:
  • ProductSelectionCreated.productSelection field type changed from ProductSelectionCreatedPayload! to ProductSelection!

Audit Log is now available in AWS Regions in beta.

You can now retrieve the shippingCustomFields and shippingKey fields on Carts and Orders with Single ShippingMode.

Changes:

• [API] Added the shippingCustomFields field to Cart and Order.
• [API] Added the shippingKey field to Cart and Order.
• [GraphQL API] Changed the Cart type:
  • Added the shippingKey field to the Cart type.
  • Added the shippingCustomFields field to the Cart type.
• [GraphQL API] Changed the Order type:
  • Added the shippingKey field to the Order type.
  • Added the shippingCustomFields field to the Order type.

We introduced the key field on TaxRate and TaxRateDraft. This ensures a consistent experience when working with external identifiers across different entity types in Composable Commerce.

Changes:

• [API] Added the key field to TaxRate and TaxRateDraft.
• [API] Added the taxRateKey field to Remove TaxRate and Replace TaxRate update actions.
• [API] Changed the taxRateId field to be optional on Remove TaxRate and Replace TaxRate update actions.
• [GraphQL API] Changed the TaxRate type:
  • Added the key field to the TaxRate type.
• [GraphQL API] Changed the TaxRateInput type:
  • Input field key was added to TaxRateInput type
• [GraphQL API] Changed the TaxRateDraft type:
  • Input field key was added to TaxRateDraft type
• [GraphQL API] Changed the TaxCategoryRemoveTaxRate type:
  • Input field taxRateKey was added to TaxCategoryRemoveTaxRate type
  • TaxCategoryRemoveTaxRate.taxRateId input field type changed from String! to String
• [GraphQL API] Changed the TaxCategoryReplaceTaxRate type:
  • TaxCategoryReplaceTaxRate.taxRateId input field type changed from String! to String
  • Input field taxRateKey was added to TaxCategoryReplaceTaxRate type

We fixed the Reference Expansion input types on Business Unit Messages to provide a consistent experience when working with the GraphQL API. Additionally, we updated the type BusinessUnitConfiguration to align it with the HTTP API. We have also made the roles field optional on AssociateDraft in the HTTP and GraphQL API to allow creating Associates without having to assign roles.

Changes:

• [API] Changed roles field to be optional on AssociateDraft.
• [GraphQL API] Changed the AssociateDraft type:
  • AssociateDraft.roles input field type changed from [SimpleAssociateRole!]! to [SimpleAssociateRole!]
• [GraphQL API] Added the following types to the GraphQL schema: BusinessUnitConfigurationStatus.
• [GraphQL API] Changed the BusinessUnitConfiguration type:
  • BusinessUnitConfiguration.myBusinessUnitStatusOnCreation field type changed from BusinessUnitStatus! to BusinessUnitConfigurationStatus!
• [GraphQL API] Changed the BusinessUnitStoreAdded type:
  • BusinessUnitStoreAdded.store field type changed from KeyReference! to Store!
  • Added the storeRef field to the BusinessUnitStoreAdded type.
• [GraphQL API] Changed the BusinessUnitStoresSet type:
  • BusinessUnitStoresSet.stores field type changed from [KeyReference!]! to [Store!]!
  • Added the storesRef field to the BusinessUnitStoresSet type.
• [GraphQL API] Changed the BusinessUnitStoreModeChanged type:
  • Added the oldStoresRef field to the BusinessUnitStoreModeChanged type.
  • Added the storesRef field to the BusinessUnitStoreModeChanged type.
  • BusinessUnitStoreModeChanged.stores field type changed from [KeyReference!] to [Store!]
  • BusinessUnitStoreModeChanged.oldStores field type changed from [KeyReference!] to [Store!]
• [GraphQL API] Changed the BusinessUnitParentChanged type:
  • Added the oldParentUnitRef field to the BusinessUnitParentChanged type.
  • Added the newParentUnitRef field to the BusinessUnitParentChanged type.
  • BusinessUnitParentChanged.newParentUnit field type changed from KeyReference to BusinessUnit
  • BusinessUnitParentChanged.oldParentUnit field type changed from KeyReference to BusinessUnit
• [GraphQL API] Changed the ChangeProjectSettingsMyBusinessUnitStatusOnCreation type:
  • ChangeProjectSettingsMyBusinessUnitStatusOnCreation.status input field type changed from BusinessUnitStatus! to BusinessUnitConfigurationStatus!
• [GraphQL API] Changed the BusinessUnitStoreRemoved type:
  • BusinessUnitStoreRemoved.store field type changed from KeyReference! to Store!
  • Added the storeRef field to the BusinessUnitStoreRemoved type.

We introduced the Individual Exclusion Product Selection type that lets you model the availability of your Products in different Stores by excluding individual Products explicitly. Before, we supported the Individual type only in which you include individual Products explicitly. We also added Messages triggered when Product Selections of that new type are created, deleted, or updated.

Changes:

• [API] Added individualExclusion value to ProductSelectionTypeEnum.

• [API] Added IndividualExclusionProductSelectionType.

• [API] Added Exclude Product update action for Product Selections.

• [API] Added Set Variant Exclusion update action for Product Selections.

• [API] Added ProductSelectionProductExcluded and ProductSelectionVariantExclusionChanged Message.

• [GraphQL API] Added the following types to the GraphQL schema: ExcludeProductSelectionProduct, IndividualExclusionProductSelectionCreatedPayload, ProductSelectionProductExcluded, ProductSelectionType, ProductSelectionVariantExclusionChanged, ProductVariantExclusion, ProductVariantExclusionDraft, SetProductSelectionVariantExclusion.

• [GraphQL API] Added the type field to the ProductSelection type.

• [GraphQL API] Added the type input field to the CreateProductSelectionDraft type.

• [GraphQL API] Added the excludeProduct input field to ProductSelectionUpdateAction type.

• [GraphQL API] Added the setVariantExclusion input field to ProductSelectionUpdateAction type.

• [GraphQL API] Added the staged field to the ProductVariantDeleted type.

We changed the type for the state field in PaymentStatusDraft from Reference to ResourceIdentifier allowing you to reference a State by key when creating a new Payment. The HTTP API now behaves as documented, and we aligned the GraphQL API with this behavior also.

Changes:

• [GraphQL API] Changed the PaymentStatusInput.state input field type from ReferenceInput to ResourceIdentifierInput.

We renamed the types of Product Variant Selection from Inclusion to IncludeOnly and from Exclusion to IncludeAllExcept. Based on our feedback, the new names describe the semantics of these types better and make their purpose clearer.

The previous types have now been deprecated and will be migrated to the new types automatically on 30 June 2023 without any disruption of services.

Changes:

• [API] Added includeOnly and includeAllExcept values to the type field of Product Variant Selection.
• [API] Deprecated inclusion and exclusion values on the type field of Product Variant Selection.
• [GraphQL API] Changed the ProductVariantSelectionDraft type:
  • Added input field includeOnly and includeAllExcept to ProductVariantSelectionDraft type.
  • Deprecated input field inclusion and exclusion on ProductVariantSelectionDraft type.
• [GraphQL API] Added the following types to the GraphQL schema: ProductVariantSelectionIncludeOnly, ProductVariantSelectionIncludeAllExcept.
• [GraphQL API] Deprecated the following types on the GraphQL schema: ProductVariantSelectionExclusion, ProductVariantSelectionInclusion.

We are announcing that external OAuth is out of beta. During the beta phase, we collected feedback to ensure a reliable, stable, and performant feature.

The status of the following functionality has changed to general availability:

• Requesting an access token using an External OAuth server.
• Configuring external OAuth through Project settings using the Set ExternelOAuth update action.

We have enhanced API Extensions to support Cloud Functions natively.

Using the GoogleCloudFunctionDestination you can directly invoke Cloud Functions without providing authorization headers or having to use intermediate gateways.

The new destination uses the permissions granted through Identity and Access Management (IAM) of Google Cloud Platform projects. Visit the API Extensions reference to learn more about using IAM-authorized Cloud Functions as destinations for your API Extensions.

Changes:

• [API] Added GoogleCloudFunctionDestination to API Extensions.
• [GraphQL API] Added the following types to the GraphQL schema: GoogleCloudFunctionDestination, GoogleCloudFunctionDestinationInput.
• [GraphQL API] Changed the ExtensionDestinationInput type:
  • Input field GoogleCloudFunction was added to ExtensionDestinationInput type.

Quote Requests, Staged Quotes, and Quotes now support Reference Expansion on Business Unit in the GraphQL API.

Changes:

• [GraphQL API] Changed the StagedQuote type:
  • Added the businessUnitRef field to the StagedQuote type.
  • StagedQuote.businessUnit field type changed from KeyReference to BusinessUnit
• [GraphQL API] Changed the Quote type:
  • Added the businessUnitRef field to the Quote type.
  • Quote.businessUnit field type changed from KeyReference to BusinessUnit
• [GraphQL API] Changed the QuoteRequest type:
  • Added the businessUnitRef field to the QuoteRequest type.
  • QuoteRequest.businessUnit field type changed from KeyReference to BusinessUnit

To align with the PriceDraft object in the HTTP API we added the discounted field to the ProductPriceDataInput type in the GraphQL schema. Furthermore, we fixed the field type for the DiscountedProductPriceValueInput type in the GraphQL API.

Changes:

• [GraphQL API] Added discounted field to the ProductPriceDataInput type.
• [GraphQL API] Changed the DiscountedProductPriceValueInput.discount field type from ReferenceInput! to ResourceIdentifierInput!.

We added the oldValue field to the Standalone Price Value Changed Message that contains the StandalonePrice value as it was before the change. You can now see how much the value of your updated Standalone Price has changed by comparing the Message fields value and oldValue.

Changes:

• [API] Added field oldValue to Standalone Price Value Changed Message.
• [GraphQL API] Changed the StandalonePriceValueChanged type:
  • Added the oldValue field to the StandalonePriceValueChanged type.

We are announcing that CloudEventsFormat for Subscription destinations is out of beta.

In the process of bringing the feature to general availability status, we ensured that the payload format is in accordance with the 1.0.2 specification. This will ensure consistency when using CloudEvents across different services.

Visit the API reference to learn more about enabling CloudEvents for your Subscription destinations.

To align with the HTTP API, multiple Shipping Methods are now supported on Carts and Orders in the GraphQL API.

Changes:

• [GraphQL API] Added the following types to the GraphQL schema: AddCartCustomShippingMethod, AddCartShippingMethod, CustomShippingDraft, MethodTaxRate, RemoveCartShippingMethod, Shipping, ShippingDraft, ShippingMode.
• [GraphQL API] Changed the MyCartDraft type:
  • Input field shippingMode was added to MyCartDraft type
  • Input field customShipping was added to MyCartDraft type
  • Input field shipping was added to MyCartDraft type
• [GraphQL API] Changed the CartDraft type:
  • Input field customShipping was added to CartDraft type
  • Input field shipping was added to CartDraft type
  • Input field shippingMode was added to CartDraft type
• [GraphQL API] Changed the CartUpdateAction type:
  • Input field addCustomShippingMethod was added to CartUpdateAction type
  • Input field removeShippingMethod was added to CartUpdateAction type
  • Input field addShippingMethod was added to CartUpdateAction type
• [GraphQL API] Changed the Cart type:
  • Added the taxedShippingPrice field to the Cart type.
  • Added the shipping field to the Cart type.
  • Added the shippingMode field to the Cart type.
• [GraphQL API] Changed the Order type:
  • Added the taxedShippingPrice field to the Order type.
  • Added the shipping field to the Order type.
  • Added the shippingMode field to the Order type.
• [GraphQL API] Changed the LineItem type:
  • Added the perMethodTaxRate field to the LineItem type.
  • Added the taxedPricePortions field to the LineItem type.
• [GraphQL API] Changed the ShippingTargetDraft type:
  • Added the shippingMethodKey field to the ShippingTargetDraft type.

With the new purchaseOrderNumber field, Buyers are now able to track their purchase throughout the order creation process with their Purchase Order Number. To support B2B scenarios, this new field is also supported on all types related to Quotes.

Changes:

• [API] Added optional field purchaseOrderNumber to OrderFromCartDraft, OrderImportDraft, QuoteRequestDraft, QuoteRequest, StagedQuote, Quote, Order.
• [API] Added setPurchaseOrderNumber update action to Orders and Order Edits APIs.
• [API] Added PurchaseOrderNumberSet message.
• [GraphQL API] Changed the QuoteRequestDraft type:
  • Input field purchaseOrderNumber was added to QuoteRequestDraft type
• [GraphQL API] Changed the OrderCartCommand type:
  • Input field purchaseOrderNumber was added to OrderCartCommand type
• [GraphQL API] Changed the ImportOrderDraft type:
  • Input field purchaseOrderNumber was added to ImportOrderDraft type
• [GraphQL API] Changed the StagedOrderUpdateAction type:
  • Input field setPurchaseOrderNumber was added to StagedOrderUpdateAction type
• [GraphQL API] Changed the StagedQuote type:
  • Added the purchaseOrderNumber field to the StagedQuote type.
• [GraphQL API] Changed the OrderUpdateAction type:
  • Input field setPurchaseOrderNumber was added to OrderUpdateAction type
• [GraphQL API] Changed the Quote type:
  • Added the purchaseOrderNumber field to the Quote type.
• [GraphQL API] Changed the Order type:
  • Added the purchaseOrderNumber field to the Order type.
• [GraphQL API] Changed the QuoteRequest type:
  • Added the purchaseOrderNumber field to the QuoteRequest type.

We introduced a background service that reflects any change for SKUs performed on Products in all corresponding SKUs on ProductVariantSelections. This service keeps SKUs in ProductSelectionAssignments up to date with eventual consistency.

We deprecated IronMQ as a Subscription destination in 2018 due to low adoption. The feature is now completely removed and newer versions of our SDKs no longer support it.

You can now retrieve Shipping Methods that match a given Cart and Location. The new endpoint is especially useful in cases where a Cart must match Shipping Method predicates, but does not have its shippingAddress defined. For example, this allows you to retrieve applicable Shipping Methods for a Cart with multiple Shipping Methods.

Changes:

• [API] added Get ShippingMethods for a Cart and Location endpoint.

AWSLambdaDestination now accepts Lambda function aliases. This allows you to optimize your development and deployment workflows by pointing to a specific version of a Lambda in your API Extension.

Changes:

• [API] The arn field of AWSLambdaDestination now accepts AWS Lambda function aliases.

We have added the option to freeze Carts during the purchasing journey of your Customers. With this, usual price and discount updates are primarily not applied on frozen Carts. This new feature is useful if you want to prevent Carts from being modified by changes affecting prices until the order is placed. Inventory is not reserved by freezing a Cart.

Changes:

• [API] Added FreezeCart and UnfreezeCart update actions to Carts API.
• [API] Added Frozen field to CartState.
• [GraphQL API] Added the following types to the GraphQL schema: FreezeCart, UnfreezeCart.
• [GraphQL API] Added input fields freezeCart and unfreezeCart to the CartUpdateAction type.
• [GraphQL API] Added Frozen value to the CartState enum type.

To fully comply with the GraphQL response format, we have moved the code field under the extensions map as shown in this example.

From 15 January 2023, code will no longer be returned as a top-level field of the errors array, but under the extensions map.

As a part of the same initiative oriented towards complying with the GraphQL specification, we also removed support for non-standard variables. This change was announced on 4 October 2022 and took effect on 1 December 2022.

In addition to identifying Embedded Prices by their id, you can now use key as a user-defined unique identifier. By assigning a human-readable key to Embedded Prices, you have greater flexibility for referencing Embedded Prices.

The key field was already available for StandalonePrices and this allowed us to assess and confirm its usefulness. Implementing the key field in Embedded Prices ensures consistency in offerings for both Standalone Prices and Embedded Prices.

Update actions for setting the key value has also been added for both Embedded Prices and Standalone Prices, allowing you to efficiently update Price keys without needing to bulk import Prices with the updated price keys.

Changes:

• [API] Added keyfield to Price and PriceDraft.
• [API] Added Set Price Key update action.
• [API] Added Set Standalone Price Key update action.
• [API] Added the error code DuplicatePriceKey.
• [API] Added ProductPriceKeySet Message.
• [API] Added StandalonePriceKeySet Message.
• [GraphQL API] Changed the ProductPrice type:
  • Added the key field to the ProductPrice type.
• [GraphQL API] Changed the ProductPriceSearch type:
  • Added the key field to the ProductPriceSearch type.
• [GraphQL API] Changed the ProductPriceDataInput type:
  • Input field key was added to ProductPriceDataInput type
• [GraphQL API] Added the following types to the GraphQL schema: SetProductPriceKey, SetStandalonePriceKey, StandalonePriceKeySet, ProductPriceKeySet.
• [GraphQL API] Changed the ProductUpdateAction type:
  • Input field setPriceKey was added to ProductUpdateAction type
• [GraphQL API] Changed the StandalonePriceUpdateAction type:
  • Input field setKey was added to StandalonePriceUpdateAction type

We have made several improvements and changes to the Business Units functionality in GraphQL:

• Carts and Orders now support Reference Expansion on Business Unit.
• Added support for creating Carts that reference a Business Unit.
• Changed the naming of the type AssociateRole to free up the namespace for new functionality.

Changes:

• [GraphQL API] Changed the Cart type:
  • Added the businessUnitRef field to the Cart type.
  • Cart.businessUnit field type changed from KeyReference to BusinessUnit
• [GraphQL API] Changed the Order type:
  • Order.businessUnit field type changed from KeyReference to BusinessUnit
  • Added the businessUnitRef field to the Order type.
• [GraphQL API] Changed the CartDraft type:
  • Input field businessUnit was added to CartDraft type
• [GraphQL API] Changed the MyCartDraft type:
  • Input field businessUnit was added to MyCartDraft type
• [GraphQL API] Added the following types to the GraphQL schema: SimpleAssociateRole
• [GraphQL API] Removed the following types from the GraphQL schema: AssociateRole.
• [GraphQL API] Changed the Associate type:
  • Associate.roles field type changed from [AssociateRole!]! to [SimpleAssociateRole!]!
• [GraphQL API] Changed the AssociateDraft type:
  • AssociateDraft.roles input field type changed from [AssociateRole!]! to [SimpleAssociateRole!]!

You can now subscribe to Messages about adding, changing, setting, and removing Embedded Prices on Products, as well as setting the PriceMode on Products.

Changes:

• [API] Added ProductPriceAdded Message.
• [API] Added ProductPriceChanged Message.
• [API] Added ProductPricesSet Message.
• [API] Added ProductPriceRemoved Message.
• [API] Added ProductPriceModeSet Message.
• [GraphQL API] Added the following types to the GraphQL schema: ProductPriceAdded, ProductPriceChanged, ProductPriceModeSet, ProductPriceRemoved, ProductPricesSet.

We have extended the abilities of Audit Log to include tracking of changes made on a Store's Product Selections. With this enhancement, all Product Selection-related Changes performed on Stores are tracked from now on and these Changes are now retrievable via API.

We understood there is a demand to retrieve the full information about the Channel and the Customer Group on Standalone Prices instead of just the reference to those via the GraphQL API. Before, additional API calls were needed to retrieve the respective information, from now on just one query is sufficient for this use case.

Changes:

• [GraphQL API] Changed the StandalonePrice type:
  • Added the channel field to the StandalonePrice type.
  • Added the customerGroup field to the StandalonePrice type.

We have released countries in Stores in public beta. You can now define countries on Stores and filter prices by country in Product Projections and Cart/Order/Shopping List Line Items.

Changes:

• [API] Added type StoreCountry to Stores.
• [API] Added countries field to Store and StoreDraft.
• [API] Added Add Country, Remove Country, and Set Countries update actions to Stores.
• [API] Added optional countries field to StoreCreated Message.
• [API] Added StoreCountriesChanged Message.
• [API] Added the error code CountryNotConfiguredInStore.
• [GraphQL API] Added the following types to the GraphQL schema: AddStoreCountry, RemoveStoreCountry, SetStoreCountries, StoreCountriesChanged, StoreCountry, StoreCountryInput.
• [GraphQL API] Changed the StoreUpdateAction type:
  • Input field addCountry was added to StoreUpdateAction type
  • Input field setCountries was added to StoreUpdateAction type
  • Input field removeCountry was added to StoreUpdateAction type
• [GraphQL API] Changed the CreateStore type:
  • Input field countries was added to CreateStore type
• [GraphQL API] Changed the StoreCreated type:
  • Added the countries field to the StoreCreated type.
• [GraphQL API] Changed the Store type:
  • Added the countries field to the Store type.

We made a correction to the ChangeQuoteState type in the GraphQL API. The type of the input field quoteState was incorrectly marked as MyQuoteState instead of QuoteState. This caused certain QuoteStates, for example, the Withdrawn state, to be unavailable through the GraphQL API. With this correction in place, the ChangeQuoteState type now supports all QuoteStates in GraphQL.

Changes:

• [GraphQL API] Changed the ChangeQuoteState type:
  • ChangeQuoteState.quoteState input field type changed from MyQuoteState! to QuoteState!

You can now organize related Attributes together into Attributes Groups and ease your product data enhancement workflows.

Changes:

• [API] Added Attribute Groups API.
• [API] Added the view_attribute_groups and manage_attribute_groups OAuth scopes.
• [GraphQL API] Added the following types to the GraphQL schema: AddAttributeGroupAttribute, AttributeGroup, AttributeGroupDraft, AttributeGroupQueryResult, AttributeGroupUpdateAction, ChangeAttributeGroupName, RemoveAttributeGroupAttribute, SetAttributeGroupAttributes, SetAttributeGroupDescription, SetAttributeGroupKey, AttributeReference.