Release Notes

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.
• [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, please contact Support via the Support Portal.

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, please contact Support via the Support Portal.

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.

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, please contact Support via the Support Portal.

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 and PHP 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

Following the deprecation of the Missing Data API due to low adoption and usage, we have now removed all its endpoints and data types.

The API was an experimental project and removing it will help us focus our efforts toward developing more advanced machine learning features while prioritizing data quality.

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.

You can now enable automatic state transitions between various pre-defined states for Quote Requests, Staged Quotes, and Quotes. In particular:

• When creating a Staged Quote you can transition the referenced Quote Request to the Accepted state using the quoteRequestStateToAccepted field on StagedQuoteDraft.
• When creating a Quote you can transition the referenced Staged Quote to the Sent state using the stagedQuoteStateToSent field on QuoteDraft.
• When creating an Order you can transition the referenced Quote to the Accepted state using the quoteStateToAccepted field on OrderFromQuoteDraft. The same functionality is available on the My Order endpoint using MyOrderFromQuoteDraft.

This simplifies the management of Quote states by eliminating the need for an additional API call to transition the state.

We have added support for IAM-based authentication for SNS and SQS Destinations. The new field authenticationMode is available on SQSDestination and SNSDestination and defines the mode of authentication. IAM-based authentication allows the Subscriptions API to send messages to a queue or publish to a topic, without explicitly providing credentials in the form of an accessKey and accessSecret. This simplifies key management for customers who maintain hundreds of queues and rotate credentials regularly. By providing permissions to an IAM user instead, the access needs to be set up once per topic and requires no additional key management. For backwards compatibility, the authenticationMode field is set to Credentials by default.

Changes:

• [API] Added fields authenticationMode to SQSDestination and SNSDestination.
• [API] Added AwsAuthenticationMode.
• [GraphQL API] Added the following types to the GraphQL schema: AwsAuthenticationMode.
• [GraphQL API] Changed the SQSDestinationInput type:
  • SQSDestinationInput.accessSecret input field type changed from String! to String
  • SQSDestinationInput.accessKey input field type changed from String! to String
  • Input field authenticationMode was added to SQSDestinationInput type
• [GraphQL API] Changed the SNSDestinationInput type:
  • SNSDestinationInput.accessSecret input field type changed from String! to String
  • SNSDestinationInput.accessKey input field type changed from String! to String
  • Input field authenticationMode was added to SNSDestinationInput type
• [GraphQL API] Changed the SQSDestination type:
  • SQSDestination.accessSecret field type changed from String! to String
  • Added the authenticationMode field to the SQSDestination type.
  • SQSDestination.accessKey field type changed from String! to String
• [GraphQL API] Changed the SNSDestination type:
  • SNSDestination.accessSecret field type changed from String! to String
  • SNSDestination.accessKey field type changed from String! to String
  • Added the authenticationMode field to the SNSDestination type.

The My Quotes API provides access to Quotes scoped to a specific user. Using the My Quotes endpoints, Buyers can view and update Quotes that they have access to. By updating the state of the Quote, Buyers can indicate whether they accept or decline a given Quote.

Changes:

• [API] Added My Quotes API.
• [API] Added MyOrderFromQuoteDraft to My Orders.
• [API] Added Create Order from Quote endpoint to My Orders.
• [GraphQL API] Added the following types to the GraphQL schema: ChangeMyQuoteMyQuoteState, MyQuoteState, MyQuoteUpdateAction, OrderMyQuoteCommand
• [GraphQL API] Changed the Me type:
  • Added the quote field to the Me type.
  • Added the quotes field to the Me type.
• [GraphQL API] Changed the Mutation type:
  • Added the updateMyQuote field to the Mutation type.

We have released Business Units in public beta. This new feature allows you to model companies and their divisions in Composable Commerce. You can assign Customers to Business Units to manage Carts, Orders, and Quotes on behalf of companies. With the help of Stores, Business Units can support company-specific products and pricing. When linked to a Business Unit, Carts, Orders, and Quotes will validate a Customer's role within the Business Unit. This feature is part of Composable Commerce for B2B and will be subject to additional terms and pricing.

To be fully compliant with the GraphQL specification for serving over HTTP, we will be accepting GraphQL variables only as a JSON objects from 1 December 2022.

From then on, we will no longer accept variables to be passed as String containing a JSON object.

Please find an example on how to use GraphQL variables on our GraphQL API page.

To align with the HTTP API we released following Carts- and Quotes-related features in the GraphQL API.

Changes:

• [GraphQL API] Added the inventoryMode field to the LineItem type.
• [GraphQL API] Added Enum value Quote to CartOrigin type .
• [GraphQL API] Added the sellerComment field to the StagedQuote type.

You can now view Product Selections limits for Stores in the GraphQL API.

Changes:

• [GraphQL API] Changed the StoreLimitsProjection type:
  • Added the productSelections field to the StoreLimitsProjection type.

We understood from our customers that there is a need to store more than 100 Line Items in a Shopping List and after analyzing the performance impact of higher numbers of Line Items we can now raise this limit to 250. This limit can be increased per Project after we reviewed the performance impact. Find more details in the documentation.

You can now subscribe to Messages about additions, removals, or overwrites of inventory supply Channels on Stores.

Changes:

• [API] Added StoreSupplyChannelsChanged Message.
• [GraphQL API] Added the following type to the GraphQL schema: StoreSupplyChannelsChanged.

With the new ShipmentState, Delivered, you can now track the orders that are received by the customer.

Previously, this was only possible by using a custom state on the Order, or on the Line Item if they have more shipments per Order.

With the new 'active' field on Standalone Prices you can activate or deactivate individual Standalone Prices. This allows you to make changes or edits to your prices without them being visible to your customers. When a Standalone Price is not active, it is not considered during price selection. All existing Standalone Prices received an active status.

Due to low adoption, we have deprecated all endpoints and data types of the Missing Data API. This API was an early, experimental project that did not find wide adoption and steady usage. Data quality remains a key priority for us and deprecating the Missing Data API will help focus our development efforts toward new, more advanced machine learning features.

We continue to maintain the Missing Data API until 09 December 2022, at which point the API will be completely removed. From now on, requests to deprecated endpoints will yield a response with the X-DEPRECATION-NOTICE HTTP header.

You can now subscribe to Messages about name changes on Stores.

Changes:

• [API] Added StoreNameSet Message.
• [GraphQL API] Added the following type to the GraphQL schema: StoreNameSet.

After successful experiences with Projects having up to 50,000 Stores, we have now raised this limit to 300,000. With this, we provide better support for B2B scenarios now in which separate product catalogs with pricing for business units of companies are required.

This limit can be increased per Project after we reviewed the performance impact. See also documentation.

Direct Discounts on Carts are now supported in the GraphQL API. The feature has been released in beta in the HTTP API on 30 June 2022.

Changes:

• [GraphQL API] Added the following types to the GraphQL schema: DirectDiscount, DirectDiscountDraft, DirectDiscountDraftOutput, SetCartDirectDiscounts, SetStagedOrderDirectDiscounts, SetStagedOrderDirectDiscountsOutput.
• [GraphQL API] Changed the Quote type:
  • Added the directDiscounts field to the Quote type.
• [GraphQL API] Changed the QuoteRequest type:
  • Added the directDiscounts field to the QuoteRequest type.
• [GraphQL API] Changed the CartUpdateAction type:
  • Input field setDirectDiscounts was added to CartUpdateAction type
• [GraphQL API] Changed the Cart type:
  • Added the directDiscounts field to the Cart type.
• [GraphQL API] Changed the StagedOrderUpdateAction type:
  • Input field setDirectDiscounts was added to StagedOrderUpdateAction type
• [GraphQL API] Changed the Order type:
  • Added the directDiscounts field to the Order type.

As announced previously in our long-term support plan for Composable Commerce SDKs, Version 1 (v1) of our PHP and .NET Core SDKs are now deprecated effective today.

These SDKs will not receive any future updates to fix bugs or security vulnerabilities. If you are using one of these SDKs, you should migrate to PHP v2 or .NET v2. You can find migration guides for both SDKs on their respective pages.

We fixed the GraphQL type for changing the Cart Discounts on Discount Codes to achieve alignment with the respective update action on the Discount Codes API. With this, you can now reference the CartDiscounts by user-defined key in addition to id also in the GraphQL API. Furthermore, we made the Channel-related fields optional in the Store Distribution Channels Changed Message.

You can now add multiple Shipping Methods to a Cart and Order. This is useful for cases where you want to have individual Shipping Methods for each Line Item ordered from a Cart.

A newly introduced shippingMode on Cart and Order controls whether Carts and Orders can have single or multiple Shipping Methods. The default ShippingMode is Single for backwards compatibility. For Carts and Orders with multiple Shipping Methods, all shipping-related information (such as address, rate, deliveries) are wrapped in a newly introduced Shipping object per Shipping Method. The Shipping object can also be extended with Custom Fields.

Additionally, you can add deliveries to Carts during Cart creation, which was previously only possible on Orders.

You can now subscribe to Messages about language changes on Stores.

Changes:

• [API] Added StoreLanguagesChanged Message.
• [GraphQL API] Added the following type to the GraphQL schema: StoreLanguagesChanged.

Buyers can now request to renegotiate a Quote provided by the Seller. Previously, Buyers only had the option to accept or reject a Quote. Renegotiation offers more flexibility and allows Buyers to ask for amendments to the Quote. Buyers can express additional details regarding their request in the form of a comment.

You can now set the price mode for a Custom Line Item when adding the Custom Line Item to a Cart.

Previously, new Custom Line Items had the Standard price mode set by default for backwards compatibilty. You could only change the price mode on an existing Custom Line Item with the Change CustomLineItem Price Mode update action.

Reference Expansion for Attributes of ProductProjectionsSearch is now supported in the GraphQL API.

We appreciate your feedback on this new in public beta feature. An example query can be found in our GraphQL API documentation.

Changes:

• [GraphQL API] Changed the RawProductSearchAttribute type:
  • Added the referencedResourceSet field to the RawProductSearchAttribute type.
  • Added the referencedResource field to the RawProductSearchAttribute type.

With Staged Standalone Prices, you can make changes or edits to Standalone Prices without them being visible to your customers. This allows you to prepare and test your changes before applying them with confidence when they are ready. Staged Standalone Prices support DiscountedPrice which means that you can assess how a given Product Discount would affect your Prices before making them live. Staged Standalone Prices is currently available in public beta.

Changes:

• [API] Added StagedStandalonePrice to Standalone Prices API.
• [API] Added field staged to StandalonePrice.
• [API] Added applyStagedChanges update action to StandalonePrice.
• [API] Added StandalonePriceStagedChangesApplied Message.
• [API] Added field staged to StandalonePriceValueChanged Message
• [GraphQL API] Added the following types to the GraphQL schema: ApplyStagedChanges, StagedStandalonePrice, StandalonePriceStagedChangesApplied.
• [GraphQL API] Changed the StandalonePriceUpdateAction type:
  • Input field applyStagedChanges was added to StandalonePriceUpdateAction type
• [GraphQL API] Changed the ChangeStandalonePriceValue type:
  • Input field staged was added to ChangeStandalonePriceValue type
• [GraphQL API] Changed the StandalonePrice type:
  • Added the staged field to the StandalonePrice type.
• [GraphQL API] Changed the StandalonePriceValueChanged type:
  • Added the staged field to the StandalonePriceValueChanged type.

You can now set States reflecting custom business logic on QuoteRequests, StagedQuotes, and Quotes.

In our June 14, 2022 release we incorrectly labeled some closed beta features as available in public beta and introduced them in our GraphQL schema file.

We made a correction to the schema file and the original release note to remove the closed beta features listed below. This does not change the availability of the features. They remain discoverable through introspection and are intended for selected customers taking part in closed beta programs.

If you are interested in evaluating a closed beta feature, please reach out to your contact at commercetools.

You can now extend the Quotes APIs with your custom business logic using API Extensions. You can trigger Extensions on create and update requests to Quote Requests, Staged Quotes, and Quotes. This allows you to integrate with other services seamlessly and cover custom B2B use cases by modifying the default behavior of the APIs.

Changes:

• [API] Added quote-request, staged-quote, and quote to ExtensionResourceTypeId.

The inventory mode can now be configured for individual LineItems. The Cart/Order-level inventory mode remains, but can be overridden on a per-line-item basis. For example, in a Cart with two Line Items, you can now give Line Item 1 an inventory mode that is different from the inventory mode for Line Item 2. Before this release, it was only possible to specify one inventory mode valid for all Line Items in the Cart or Order.

Changes:

• [API] Added optional inventoryMode field to LineItem, LineItemDraft, and LineItemImportDraft.
• [GraphQL API] Changed the LineItemDraftOutput type:
  • Added the inventoryMode field to the LineItemDraftOutput type.
• [GraphQL API] Changed the AddStagedOrderLineItem type:
  • Input field inventoryMode was added to AddStagedOrderLineItem type
• [GraphQL API] Changed the AddCartLineItem type:
  • Input field inventoryMode was added to AddCartLineItem type
• [GraphQL API] Changed the LineItemDraft type:
  • Input field inventoryMode was added to LineItemDraft type

You can now set a price mode on a CustomLineItem that controls whether Cart Discounts should be applied to them by Composable Commerce or not. Use this if you want to control application of Cart Discounts for each Custom Line Item in the Cart individually. For backwards compatibility, Standard is the default price mode for newly created Custom Line Items, that allows application of Cart Discounts. For cases where Cart Discounts should not be considered on a Custom Line Item, you can change its price mode to External via new update action. You can still overwrite the price for a Custom Line Item via Change CustomLineItem Money update action.

Changes:

• [API] Added field priceMode to CustomLineItem.
• [API] Added Change CustomLineItem Price Mode update action to Carts.
• [GraphQL API] Added the following types to the GraphQL schema: ChangeCartCustomLineItemPriceMode, CustomLineItemPriceMode.
• [GraphQL API] Changed the CartUpdateAction type:
  • Input field changeCustomLineItemPriceMode was added to CartUpdateAction type
• [GraphQL API] Changed the CustomLineItem type:
  • Added the priceMode field to the CustomLineItem type.
• [GraphQL API] Changed the TypeDefinition type:
  • TypeDefinition type description is changed

We have extended the capabilities of Audit Log to include the tracking of changes made on Quotes, Quote Requests, and Staged Quotes. With this enhancement, all Changes performed on Quotes, Quotes Requests and Staged Quotes are tracked from now on and these Changes are now retrievable via API.

Changes:

• [API] Added scopes view_quotes:{projectKey}, view_quotes:{projectKey}, and view_quotes:{projectKey}.
• [API] Added quote, quote-request, and staged-quote to ChangeHistoryResourceType.
• [API] Added ChangeQuoteRequestStateChange, ChangeQuoteStateChange, ChangeStagedQuoteStateChange, SetSellerCommentChange, and SetValidToChange.
• [API] Added StagedQuoteLabel, QuoteRequestLabel, QuoteLabel, and StagedQuoteLabel.
• [GraphQL API] Added the following types to the graphQL schema: QuoteRequestChangeInput, QuoteChangeInput and StagedQuoteChangeInput.
• [GraphQL API] Added QuoteRequestLabel, QuoteLabel, and StagedQuoteLabel type.
• [GraphQL API] Added queries quoteRequest and quoteRequests.
• [GraphQL API] Added queries quote and quotes.
• [GraphQL API] Added queries stagedQuote and stagedQuotes.
• [GraphQL API] Added QuoteRequest, Quote, and StagedQuote to the ResourceType enum.

You can now subscribe to Messages about additions, removals, or overwrites of product distribution Channels on Stores.

Changes:

• [API] Added StoreDistributionChannelsChanged Message.
• [GraphQL API] Added the following type to the GraphQL schema: StoreDistributionChannelsChanged.

You can now create an Order by import using the GraphQL API.

Changes:

• [GraphQL API] Added the following types to the GraphQL schema: CustomLineItemImportDraft, DeliveryDraft, DiscountedLineItemPriceDraft, ImportOrderDraft, LineItemImportDraft, ParcelDraft, ProductVariantImportDraft, ShippingInfoImportDraft, TaxRateInput, TaxedPriceDraft.
• [GraphQL API] Changed the Mutation type:
  • Added the importOrder field to the Mutation type.

You can now check if a Product Type exists using its id, key or a query predicate. These methods are useful if you are only interested in the existence of a certain Product Type without the need of fetching its information.

• [API] Added HEAD methods for Product Types by ID, by Key, and by Query Predicate.

We have extended the capabilities of Audit Log to include the tracking of changes made on Product Selections. With this enhancement, all Changes performed on Product Selections are tracked from now on and these Changes are now retrievable via API.

Changes:

• [API] Added the view_product_selections:{projectKey} scope.
• [API] Added product-selection to ChangeHistoryResourceType.
• [API] Added AddProductChange.
• [API] Added RemoveProductChange.
• [API] Added SetProductCountChange.
• [GraphQL API] Added the following types to the graphQL schema: ProductSelectionChangeInput.
• [GraphQL API] Added queries productSelection and productSelections.
• [GraphQL API] Added ProductSelection to the ResourceType enum.

We have released Quotes in public beta. This new feature allows you to negotiate quote requests for your products with your customers. The negotiation process involves utilizing several APIs that we introduced with this feature, allowing you to control each step of the intended workflow of the negotiation. All the introduced resources, such as Quote Request, Staged Quote, and Quote can be extended with Custom Fields. The discounts applied on a specific Quote, can be utilized by the newly added DirectDiscount. After successful negotiation, the Order can be created right from the Quote.

Changes:

• [API] Added Quote Requests and My Quote Requests APIs.
• [API] Added Staged Quotes API.
• [API] Added Quotes API.
• [API] Added QuoteRequestCreated, QuoteRequestStateChanged, and QuoteRequestDeleted Messages.
• [API] Added StagedQuoteCreated, StagedQuoteStateChanged, StagedQuoteValidToSet, StagedQuoteSellerCommentSet, and StagedQuoteDeleted Messages.
• [API] Added QuoteCreated, QuoteStateChanged, and QuoteDeleted Messages.
• [API] Added Quote to CartOrigin.
• [API] Added DirectDiscount and DirectDiscountDraft to Carts API.
• [API] Added directDiscounts field to Cart and Order.
• [API] Added setDirectDiscounts update action to Carts and Orders via OrderEdit.
• [API] Added OrderFromQuoteDraft and Create Order from Quote endpoint to Orders API.
• [API] Added quote field to Order.
• [API] Added OAuth scopes manage_quote_requests, view_quote_requests, manage_my_quote_requests, manage_staged_quotes, view_staged_quotes, manage_quotes, and view_quotes.
• [GraphQL API] Added the following types to the GraphQL schema: CancelQuoteRequest, ChangeMyQuoteMyQuoteState, ChangeQuoteRequestState, ChangeQuoteState, ChangeStagedQuoteState, MyQuoteRequestDraft, MyQuoteRequestUpdateAction, MyQuoteState, MyQuoteUpdateAction, OrderMyQuoteCommand, OrderQuoteCommand, Quote, QuoteDraft, QuoteQueryResult, QuoteRequest, QuoteRequestDraft, QuoteRequestQueryResult, QuoteRequestState, QuoteRequestUpdateAction, QuoteState, QuoteUpdateAction, SetMyQuoteRequestCustomField, SetMyQuoteRequestCustomType, SetQuoteCustomField, SetQuoteCustomType, SetQuoteRequestCustomField, SetQuoteRequestCustomType, SetStagedQuoteCustomField, SetStagedQuoteCustomType, SetStagedQuoteSellerComment, SetStagedQuoteValidTo, StagedQuote, StagedQuoteDraft, StagedQuoteQueryResult, StagedQuoteState, StagedQuoteUpdateAction.

You can now include or exclude particular Product Variants in/from a Product Selection. Formerly it was only possible to add Products as a whole to a Product Selection meaning that all existing Product Variants of the Product are included.

Changes:

• [API] You can now specify a Product Variant Selection when you Add a Product to the Product Selection.
• [API] You can now specify a Product Variant Selection for an existing Product in the Product Selection by the new Set Variant Selection update action.
• [API] When you query a Product Selection for Products assigned to a Product Selection the response now also contains Product Variant Selections.
• [API] When you query for Products available in a Store through active Product Selections the response now also contains Product Variant Selections.
• [API] When you Get Product Projection in Store by ID or by Key you can now project by Product Selection assignments for Product Variants.
• [API] Added variantSelection field to ProductSelectionProductAdded Message.
• [API] Added ProductSelectionVariantSelectionChanged Message.
• [API] Added ProductAssignmentMissing and ProductPresentWithDifferentVariantSelection errors.
• [GraphQL API] Added the following types to the GraphQL schema: ProductSelectionVariantSelectionChanged, ProductVariantSelection, ProductVariantSelectionDraft, ProductVariantSelectionExclusion, ProductVariantSelectionInclusion, SetProductSelectionVariantSelection.
• [GraphQL API] Changed the ProductOfSelection type:
  • Added the variantSelection field to the ProductOfSelection type.
• [GraphQL API] Changed the SelectionOfProduct type:
  • Added the variantSelection field to the SelectionOfProduct type.
• [GraphQL API] Changed the ProductSelectionUpdateAction type:
  • Input field setVariantSelection was added to ProductSelectionUpdateAction type
• [GraphQL API] Changed the AddProductSelectionProduct type:
  • Input field variantSelection was added to AddProductSelectionProduct type
• [GraphQL API] Changed the ProductSelectionProductAdded type:
  • Added the variantSelection field to the ProductSelectionProductAdded type.

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

• Querying and managing Standalone Prices through the Standalone Prices API
• Adding Custom Fields on Standalone Prices
• Setting the priceMode on the Product

Read more on Standalone Prices and how to use them in the API reference.

The long-term support plan for the Java v1 SDK has been extended until the end of 2023. This provides additional time for users to migrate to Java v2 SDK.

Changes:

• [GraphQL API] Changed the AuthenticationMode type:
  • AuthenticationMode type description is changed
• [GraphQL API] Changed the StandalonePriceCustomField type:
  • StandalonePriceCustomField type description is changed
• [GraphQL API] Changed the ProductPrice type:
  • Added the key field to the ProductPrice type.
• [GraphQL API] Changed the RoundingMode type:
  • RoundingMode.HalfDown description changed
• [GraphQL API] Changed the ProductPriceSearch type:
  • Added the key field to the ProductPriceSearch type.
• [GraphQL API] Changed the Payment type:
  • Payment type description is changed
• [GraphQL API] Changed the SelectionOfProduct type:
  • Added the createdAt field to the SelectionOfProduct type.
• [GraphQL API] Changed the MyPayment type:
  • MyPayment type description is changed
• [GraphQL API] Changed the Query type:
  • Query.standalonePrices description is changed
  • Query.standalonePrice description is changed
• [GraphQL API] Changed the ProductPriceDataInput type:
  • Input field key was added to ProductPriceDataInput type
• [GraphQL API] Changed the Cart type:
  • Argument id was added to Cart.lineItems field
• [GraphQL API] Changed the PriceMode type:
  • PriceMode type description is changed
• [GraphQL API] Changed the StandalonePriceQueryResult type:
  • StandalonePriceQueryResult.exists description is changed
• [GraphQL API] Changed the TriggerInput type:
  • Input field condition was added to TriggerInput type
• [GraphQL API] Changed the Mutation type:
  • Mutation.replicateMyCart description is changed
• [GraphQL API] Changed the Order type:
  • Order type description is changed
  • Argument id was added to Order.lineItems field
• [GraphQL API] Changed the Trigger type:
  • Added the condition field to the Trigger type.
• [GraphQL API] Changed the StandalonePrice type:
  • StandalonePrice type description is changed

You can now set the discounted value of a Standalone Price via update action also. Before, it was only possible to set that value during creation of the Standalone Price.

Changes:

• [API] Added SetStandalonePriceDiscountedPrice update action to Standalone Prices.
• [API] Added StandalonePriceExternalDiscountSet Message.
• [GraphQL API] Added the following types to the GraphQL schema: SetStandalonePriceDiscountedPrice, StandalonePriceExternalDiscountSet.
• [GraphQL API] Changed the StandalonePriceUpdateAction type:
  • Input field setDiscountedPrice was added to StandalonePriceUpdateAction type

Conditional triggers on API Extensions allow you to specify the criteria under which a given Extension is triggered. By default, API Extensions are called on every create or update to the resource they are configured for. However, the new feature allows you to specify fine-grained predicates based on the resource's properties. Using conditional statements you can configure the API Extension to trigger only when your particular use case requires it. Conditional triggers are especially useful in cases where multiple brands or countries reside in a single project.

Changes:

• [API] Added condition field to ExtensionTrigger.
• [GraphQL API] Changed the TriggerInput type:
  • Input field condition was added to TriggerInput type
• [GraphQL API] Changed the Trigger type:
  • Added the condition field to the Trigger type.

You can now subscribe to Messages specific to Standalone Prices to get informed about their creation, deletion, or updates on them.

Changes:

• [API] Added StandalonePriceCreated Message, StandalonePriceDeleted Message, StandalonePriceValueChanged Message, and StandalonePriceDiscountSet Message.
• [GraphQL API] Added the following types to the GraphQL schema: StandalonePriceCreated, StandalonePriceDeleted, StandalonePriceDiscountSet, StandalonePriceValueChanged.

The lastMessageSequenceNumber field is deprecated from Order, as it is an internal field that should not be used in customer logic. For processing Messages in the correct order, a message processor can continue to use the id field of the resource alongside the sequenceNumber of the Message.

Changes:

• [API] Removed lastMessageSequenceNumber from Order.
• [GraphQL API] Changed the Order type:
  • Field lastMessageSequenceNumber was deprecated in Order type.

The Standalone Prices feature provides an alternative way to store your product prices as standalone resources. In comparison to prices embedded inside the Product, this new approach allows increasing the limit of prices per ProductVariant from 100 to 50.000. It also brings a more flexible way to query and manage your prices, separately from your Products, which contributes to better query performance.

The feature allows you to manage and query Standalone Prices through the Standalone Prices API, and to associate them to a ProductVariant via SKU. Additionally, a new priceMode has been introduced on the Product that controls whether the Prices of the ProductVariants are embedded into the Product resource or stored separately as Standalone Prices.

Please note that currently it is not possible to use filters, facets, and sorting on Standalone Prices via the Product Projection Search endpoint.

Read more on Standalone Prices and how to use them in the API reference.

Changes:

• [API] Added Standalone Prices API.
• [API] Added view_standalone_prices and manage_standalone_prices OAuth scopes.
• [API] Added optional field priceMode to Product and ProductDraft.
• [API] Added Set PriceMode update action to Product.
• [API] Added DuplicateStandalonePriceScope and OverlappingStandalonePriceValidity 400 Bad Request errors specific to Standalone Prices.
• [GraphQL API] Added the following types to the GraphQL schema: ChangeStandalonePriceValue, CreateStandalonePrice, PriceMode, SetProductPriceMode, SetStandalonePriceCustomFields, StandalonePrice, StandalonePriceCustomField, StandalonePriceQueryResult, StandalonePriceUpdateAction.
• [GraphQL API] Changed the Query type:
  • Added the standalonePrice field to the Query type.
  • Added the standalonePrices field to the Query type.
• [GraphQL API] Changed the Mutation type:
  • Added the createStandalonePrice field to the Mutation type.
  • Added the deleteStandalonePrice field to the Mutation type.
  • Added the updateStandalonePrice field to the Mutation type.
• [GraphQL API] Changed the Product type:
  • Added the priceMode field to the Product type.
• [GraphQL API] Changed the ProductDraft type:
  • Input field priceMode was added to ProductDraft type
• [GraphQL API] Changed the ProductUpdateAction type:
  • Input field setPriceMode was added to ProductUpdateAction type

When creating an Order from a Cart, the Custom Fields in the OrderFromCartDraft now merge with the Custom Fields in the referenced Cart.

With this, you can enrich the Custom Fields that already exist on the Cart and store them in the Order with a single API call.

Changes:

• [API] The custom field on OrderFromCartDraft is now used for adding extra Custom Fields on Create Order from Cart.

Creating a new Cart by replicating an existing Cart or Order can be useful in case a Customer wants to cancel a recent order to make some changes, or if a previous order should be ordered again. This has been supported for Carts already, and now we added a replicatiion endpoint for My Carts also.

Changes:

• [API] Added Replicate My Cart endpoint.
• [API] Added ReplicaMyCartDraft.
• [GraphQL API] Changed the Mutation type:
  • Added the replicateMyCart field to the Mutation type.

You can now view and configure the deletion date of API Clients in the GraphQL API.

Changes:

• [GraphQL API] Changed the APIClientWithoutSecret type:
  • Added the deleteAt field to the APIClientWithoutSecret type.
• [GraphQL API] Changed the APIClientWithSecret type:
  • Added the deleteAt field to the APIClientWithSecret type.
• [GraphQL API] Changed the CreateApiClient type:
  • Input field deleteDaysAfterCreation was added to CreateApiClient type

The total tax amount on Cart, Order, LineItem, CustomLineItem, and ShippingInfo. Before, your application had to calculate that amount if you wanted to display it to your customers.

Changes:

• [API] Added optional totalTax field to TaxedPrice and TaxedItemPrice.
• [GraphQL API] Changed the TaxedPrice type:
  • Added the totalTax field to the TaxedPrice type.
  • Added the totalTax field to the TaxedItemPrice type.

Reference Expansion for Attributes of Products is now supported in the GraphQL API.

We appreciate your feedback on this new in public beta feature. An example query can be found in our GraphQL API documentation.

Changes:

• [GraphQL API] Changed the RawProductAttribute type:
  • Added the referencedResourceSet field to the RawProductAttribute type.
  • Added the referencedResource field to the RawProductAttribute type.

You can now add Custom Fields when you Create an Order from a Cart. With this, you can now store additional information, like payment reference, to your Order during checkout if required for your business logic.

Changes:

• [API] Added optional custom field to OrderFromCartDraft.
• [GraphQL API] Changed the OrderCartCommand type:
  • Added the custom field to OrderCartCommand type.

We have extended the abilities of Audit Log to include tracking of changes on Stores as well as on Store-related information on Customers, Orders, and Shopping Lists.

For supported resources, this enhancement will now scope Audit Log response data to the user's or API Client's Store permissions. All other resources will remain unaffected.

Changes:

• [API] Adds stores attribute to Record response.
• [API] Adds filter for store keys to all available endpoints.
• [GraphQL API] Adds stores attribute to ChangeHistory type.
• [GraphQL API] Adds filter for store keys to all queries for supported resources.

You can now set the PaymentInfo as well as a State to an Order via Order Import.

Changes:

• [API] Added optional field paymentInfo to OrderImportDraft.
• [API] Added optional field state to OrderImportDraft.

Reference Expansion for Custom Fields of CustomFieldReferenceType (as well as for the CustomFieldSetType of it) is now supported in the GraphQL API.
We appreciate your feedback on this new in public beta feature; for an example query, please refer to the respective section in the GraphQL API documentation.

Changes:

• [GraphQL API] Changed the RawCustomField type:
  • Added the referencedResourceSet field to the RawCustomField type.
  • Added the referencedResource field to the RawCustomField type.
• [GraphQL API] Changed the Cart type:
  • Cart object type now implements ReferenceExpandable interface
• [GraphQL API] Changed the CartDiscount type:
  • CartDiscount object type now implements ReferenceExpandable interface
• [GraphQL API] Changed the Category type:
  • Category object type now implements ReferenceExpandable interface
• [GraphQL API] Changed the Channel type:
  • Channel object type now implements ReferenceExpandable interface
• [GraphQL API] Changed the Customer type:
  • Customer object type now implements ReferenceExpandable interface
• [GraphQL API] Changed the CustomerGroup type:
  • CustomerGroup object type now implements ReferenceExpandable interface
• [GraphQL API] Changed the CustomObject type:
  • CustomObject object type now implements ReferenceExpandable interface
• [GraphQL API] Changed the DiscountCode type:
  • DiscountCode object type now implements ReferenceExpandable interface
• [GraphQL API] Changed the Extension type:
  • Extension object type now implements ReferenceExpandable interface
• [GraphQL API] Changed the InventoryEntry type:
  • InventoryEntry object type now implements ReferenceExpandable interface
• [GraphQL API] Changed the Message type:
  • Message object type now implements ReferenceExpandable interface
• [GraphQL API] Changed the Order type:
  • Order object type now implements ReferenceExpandable interface
• [GraphQL API] Changed the Product type:
  • Product object type now implements ReferenceExpandable interface
• [GraphQL API] Changed the ProductDiscount type:
  • ProductDiscount object type now implements ReferenceExpandable interface
• [GraphQL API] Changed the ProductTypeDefinition type:
  • ProductTypeDefinition object type now implements ReferenceExpandable interface
• [GraphQL API] Changed the Review type:
  • Review object type now implements ReferenceExpandable interface
• [GraphQL API] Changed the ShippingMethod type:
  • ShippingMethod object type now implements ReferenceExpandable interface
• [GraphQL API] Changed the ShoppingList type:
  • ShoppingList object type now implements ReferenceExpandable interface
• [GraphQL API] Changed the State type:
  • State object type now implements ReferenceExpandable interface
• [GraphQL API] Changed the Store type:
  • Store object type now implements ReferenceExpandable interface
• [GraphQL API] Changed the TaxCategory type:
  • TaxCategory object type now implements ReferenceExpandable interface
• [GraphQL API] Changed the TypeDefinition type:
  • TypeDefinition object type now implements ReferenceExpandable interface
• [GraphQL API] Changed the Zone type:
  • Zone object type now implements ReferenceExpandable interface

We introduced the AuthenticationMode that controls whether the password field is required for a Customer in public beta. The Password authentication mode is the default mode for backwards compatibility that requires to set a password for the Customer. For use cases where Customers are authenticated externally, you can now set the authenticationMode to ExternalAuth to create Customers without a password.

Changes:

• [API] Added authenticationMode field to Customer and CustomerDraft.
• [API] Changed password field to be optional on CustomerDraft when authenticationMode is set to ExternalAuth.
• [API] Removed password field from Customer when authenticationMode is set to ExternalAuth.
• [API] Added Set AuthenticationMode update action.
• [GraphQL API] Added the following types to the GraphQL schema: AuthenticationMode, SetCustomerAuthenticationMode.
• [GraphQL API] Changed the Customer type:
  • Customer.password field type changed from String! to String
  • Added the authenticationMode field to the Customer type.
• [GraphQL API] Changed the CustomerSignUpDraft type:
  • CustomerSignUpDraft.password input field type changed from String! to String
  • Input field authenticationMode was added to CustomerSignUpDraft type
• [GraphQL API] Changed the CustomerUpdateAction type:
  • Input field setAuthenticationMode was added to CustomerUpdateAction type
• [GraphQL API] Changed the CustomerSignMeUpDraft type:
  • CustomerSignMeUpDraft.password input field type changed from String! to String

InventoryEntry now supports the key field. You can now retrieve, update, and delete InventoryEntry by user-defined key.

Changes:

• [API] Added key field to InventoryEntry and InventoryEntryDraft.
• [API] Added Get, Update, and Delete by Key methods to InventoryEntry.
• [API] Added Set Key update action to InventoryEntry.
• [GraphQL API] Changed the Query type:
  • Query.inventoryEntry(id) type changed from String! to String
  • Query.inventoryEntry(id) description is changed
  • Argument key was added to Query.inventoryEntry field
• [GraphQL API] Changed the Mutation type:
  • Mutation.updateInventoryEntry(id) type changed from String! to String
  • Mutation.updateInventoryEntry(id) description is changed
  • Argument key was added to Mutation.updateInventoryEntry field
  • Mutation.deleteInventoryEntry(id) type changed from String! to String
  • Mutation.deleteInventoryEntry(id) description is changed
  • Argument key was added to Mutation.deleteInventoryEntry field

The messagePayloads field has been added to the PreviewSuccess OrderEdit result in our GraphQL API.

Changes:

• [GraphQL API] Added the following types to the GraphQL schema: OrderMessagePayload.
• [GraphQL API] Changed the OrderCustomLineItemQuantityChanged type:
  • OrderCustomLineItemQuantityChanged object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the OrderShippingRateInputSet type:
  • OrderShippingRateInputSet object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the OrderCustomLineItemRemoved type:
  • OrderCustomLineItemRemoved object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the OrderBillingAddressSet type:
  • OrderBillingAddressSet object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the ParcelItemsUpdated type:
  • ParcelItemsUpdated object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the OrderEditApplied type:
  • OrderEditApplied object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the DeliveryAdded type:
  • DeliveryAdded object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the PreviewSuccess type:
  • Added the messagePayloads field to the PreviewSuccess type.
• [GraphQL API] Changed the OrderPaymentStateChanged type:
  • OrderPaymentStateChanged object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the ReturnInfoSet type:
  • ReturnInfoSet object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the OrderCustomerSet type:
  • OrderCustomerSet object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the OrderDiscountCodeStateSet type:
  • OrderDiscountCodeStateSet object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the OrderCustomerGroupSet type:
  • OrderCustomerGroupSet object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the OrderLineItemDiscountSet type:
  • OrderLineItemDiscountSet object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the OrderStateChanged type:
  • OrderStateChanged object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the OrderLineItemAdded type:
  • OrderLineItemAdded object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the OrderImported type:
  • OrderImported object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the OrderCustomerEmailSet type:
  • OrderCustomerEmailSet object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the OrderCustomLineItemDiscountSet type:
  • OrderCustomLineItemDiscountSet object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the OrderDiscountCodeAdded type:
  • OrderDiscountCodeAdded object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the CustomLineItemStateTransition type:
  • CustomLineItemStateTransition object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the OrderPaymentRemoved type:
  • OrderPaymentRemoved object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the ParcelTrackingDataUpdated type:
  • ParcelTrackingDataUpdated object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the OrderDiscountCodeRemoved type:
  • OrderDiscountCodeRemoved object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the DeliveryRemoved type:
  • DeliveryRemoved object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the OrderCreated type:
  • OrderCreated object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the OrderLineItemRemoved type:
  • OrderLineItemRemoved object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the ParcelRemovedFromDelivery type:
  • ParcelRemovedFromDelivery object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the OrderDeleted type:
  • OrderDeleted object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the OrderStoreSet type:
  • OrderStoreSet object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the DeliveryItemsUpdated type:
  • DeliveryItemsUpdated object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the ReturnInfoAdded type:
  • ReturnInfoAdded object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the OrderReturnShipmentStateChanged type:
  • OrderReturnShipmentStateChanged object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the ParcelMeasurementsUpdated type:
  • ParcelMeasurementsUpdated object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the OrderStateTransition type:
  • OrderStateTransition object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the LineItemStateTransition type:
  • LineItemStateTransition object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the OrderLineItemDistributionChannelSet type:
  • OrderLineItemDistributionChannelSet object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the ParcelAddedToDelivery type:
  • ParcelAddedToDelivery object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the DeliveryAddressSet type:
  • DeliveryAddressSet object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the OrderCustomLineItemAdded type:
  • OrderCustomLineItemAdded object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the OrderShipmentStateChanged type:
  • OrderShipmentStateChanged object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the OrderShippingInfoSet type:
  • OrderShippingInfoSet object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the OrderShippingAddressSet type:
  • OrderShippingAddressSet object type now implements OrderMessagePayload interface
• [GraphQL API] Changed the OrderPaymentAdded type:
  • OrderPaymentAdded object type now implements OrderMessagePayload interface