Documentation

HTTP API Releases

Product Newsletter
Discover our combined Release Notes page and stay updated with the latest features and improvements! Get comprehensive details on all updates, quickly find specific updates and enhancements with our new search and filter options, and easily browse through different versions and sections.

Expand and collapse nested JSON object schemas in documentation

5 May 2025
Composable Commerce
HTTP API
Enhancement
General

We've enhanced our API documentation to make understanding complex data structures easier.

You can now interactively expand and collapse nested JSON object schemas directly within the documentation pages. This allows you to focus on the specific parts of the schema you need without navigating away.

By reducing context-switching, it streamlines your workflow, making it easier to understand and integrate our APIs.

To see it in action, click the chevron icon next to any expandable object in the API documentation. The schema will open inline, showing nested objects as data types for the fields. To close the expanded schema, click the chevron icon again.

Enhanced Product Search with filter by Inventory Entry for Channel in public beta

29 April 2025
Composable Commerce
HTTP API
Enhancement
Product catalogSearch
You can now filter Product Search results to show only products with an InventoryEntry assigned to a specific supplyChannel. Previously, filtering was limited to the current availability for the specific supply channel. This enhancement allows you to easily identify Product Variants that are listed on a specific supply channel but are currently out of stock, providing better visibility into your channel-specific inventory.
{ "query": { "and": [ { "exact": { "field": "variants.availability.hasInventoryEntryForChannel", "value": "2b62dc25-7850-4fea-80f8-2c57c90649a5" } }, { "not": [ { "exact": { "field": "variants.availability.isOnStockForChannel", "value": "2b62dc25-7850-4fea-80f8-2c57c90649a5" } } ] } ] } }

Added 'published' field to ShoppingListLineItem

29 April 2025
Composable Commerce
HTTP API
Enhancement
CartsGraphQL
We’ve added the published field to ShoppingListLineItem. This field lets you check the publication status of the associated Product without needing to retrieve it separately.

All existing ShoppingListLineItems have been updated to include the new field.

Changes:

  • [API] Added the published field to ShoppingListLineItem.
  • [GraphQL API] Added the published field to the ShoppingListLineItem type.
extend type ShoppingListLineItem { published: Boolean! }

Updated the format of Query Predicates for Product Attributes

25 April 2025
Composable Commerce
HTTP API
Enhancement
Product catalog
We have updated the format for querying Product Attributes. Query Predicates must now include the name of the Product Attribute along with its value.
If you add a new Query Predicate to query Product Attributes without including attribute-name, then a 400 Bad Request error will occur. Existing queries that use the old format will continue to work; however, we recommend that you include the attribute-name details to enhance the performance of those queries.
Product indexing for Products and Product Projection queries is limited. This means that adding a large number of indexes for Attributes can impact the performance of Product and Product Projection queries. As a result, we recommend that you only use a small number of unique query patterns that include Attributes. In addition, we recommend that you instead use the Product Search or Product Projection Search API for all storefront applications.

Incorrect Query Predicate format (no longer accepted):

variants(attributes(value="attribute-value"))

Correct Query Predicate format:

variants(attributes(name="attribute-name" and value="attribute-value"))

Introduced limits on Import Containers

22 April 2025
Composable Commerce
HTTP API
Announcement
LimitsImport Containers
To ensure optimal performance, we have introduced a default limit of 1000 Import Containers per Project.

Existing Projects exceeding this limit are not affected; however, we recommend reducing the number of Import Containers to stay within the limit. The limit can be increased on a per-Project basis after we review the performance impact.

Added support for moving Business Units to a new company

31 March 2025
Composable Commerce
HTTP API
Enhancement
B2BCustomersGraphQL

You can now move a Business Unit to a new company, providing greater flexibility for your organizational needs. With this enhancement, you can do the following:

  • Convert a company into a sub-division of another company
  • Convert a sub-division into a sub-division of another company
  • Convert a sub-division into a new company
This functionality is available in public beta. Previously, Business Units could be moved only to another parent in the same company.
This feature is only available as part of Composable Commerce for B2B and will be subject to additional terms and pricing. To get access to Composable Commerce for B2B, contact the Composable Commerce support team.

Changes:

  • [API] Added the Set Unit Type update action to the Business Units API.
  • [API] Added the BusinessUnitTopLevelUnitSet and BusinessUnitTypeSet Messages.
  • [GraphQL API] Added the following types to the GraphQL schema: SetBusinessUnitUnitType, BusinessUnitTopLevelUnitSet, BusinessUnitTypeSet.
  • [GraphQL API] Added setUnitType input field to the BusinessUnitUpdateAction type.

The following changes were introduced in terms of GraphQL SDL:

extend input BusinessUnitUpdateAction { "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" setUnitType: SetBusinessUnitUnitType } "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" input SetBusinessUnitUnitType { unitType: BusinessUnitType! parentUnit: ResourceIdentifierInput } "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" type BusinessUnitTopLevelUnitSet implements MessagePayload { oldTopLevelUnit: BusinessUnit! topLevelUnit: BusinessUnit! oldTopLevelUnitRef: KeyReference topLevelUnitRef: KeyReference type: String! } "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" type BusinessUnitTypeSet implements MessagePayload { oldUnitType: BusinessUnitType! unitType: BusinessUnitType! parentUnit: BusinessUnit oldParentUnit: BusinessUnit parentUnitRef: KeyReference oldParentUnitRef: KeyReference type: String! }

Introduced Event notifications for Import API in public beta

28 March 2025
Composable Commerce
HTTP API
New feature
Messages/Subscriptions
We have introduced Event notifications in public beta. With this new feature, you can subscribe to Events in the Import API.

By subscribing to Import API event notifications, you can improve your import experience with automatic, real-time status updates. This eliminates manual polling, and you receive proactive communication on the progress of your imports.

Changes:

Cross-cloud connectivity for Google Cloud API Extensions

28 March 2025
Composable Commerce
HTTP API
Enhancement
Security and privacyExtensibility

To further enhance security, you can now let your API Extensions connect to the services running in your own cloud through a private connection.

We recommend setting up private connectivity to other clouds for your internal APIs ensuring that only API Extension requests from commercetools can access your extension APIs.
The setup is supported for Composable Commerce Projects in the Google Cloud regions.

Best deal discount is now generally available

27 March 2025
Composable Commerce
HTTP API
Announcement
Pricing and Discounts
Following feedback gathered during the beta phase, we have moved the functionality to offer best deal discounts out of beta and into general availability. By controlling how Product and Cart Discounts interact on a Cart, you have greater flexibility in offering your customers the best deal during purchase.

Buy and Get Cart Discounts is now generally available

27 March 2025
Composable Commerce
HTTP API
Announcement
Pricing and DiscountsAudit LogGraphQL
Following feedback gathered during the beta phase, we have moved the Buy and Get Cart Discounts out of beta into general availability. The following features are now generally available:

With Buy and Get Cart Discounts, you can set up multi-purchase promotions such as Buy One, Get One (BOGO) with more flexibility and control, compared to Multi-buy Discount target.

Business Unit Search is now generally available

26 March 2025
Composable Commerce
HTTP API
Announcement
B2BCustomersSearchGraphQL
Following feedback gathered during the beta phase, we have moved the Business Unit Search API out of beta into general availability. In addition, the following features are now generally available:
Business Unit Search lets you search across a large number of Business Units within a Project with improved performance and enhanced query capabilities. It is intended for back-office use cases, and not for searching business unit data in a storefront application.
This feature is only available as part of Composable Commerce for B2B and will be subject to additional terms and pricing. To get access to Composable Commerce for B2B, contact the Composable Commerce support team.

Changed default value of 'withTotal' parameter on Product Tailoring query endpoint to false

21 March 2025
Composable Commerce
HTTP API
Enhancement
Product catalog
To improve query performance, the Query Product Tailoring endpoint no longer returns the total field in the query result by default. If necessary, you can now request this field by setting the withTotal query parameter to true. We have also corrected the documentation of other query endpoints to reflect this.

Changes:

Introduced support for multiple Customer Groups per Customer in public beta

19 March 2025
Composable Commerce
HTTP API
Enhancement
CustomersGraphQL
You can now assign a Customer to up to Customer Groups; previously, you could only assign a Customer to one Customer Group. Additionally, using the Customer Search API, you can now filter for Customers by their specific Customer Group assignments. This enhancement is available in public beta.
To transition from using a single Customer Group for a Customer to using multiple Customer Groups, see our migration guide.

Changes:

  • [API] Added the customerGroupAssignments field to the Customer and CustomerDraft types.
  • [API] Added the CustomerGroupAssignment and CustomerGroupAssignmentDraft types to the Customers API.
  • [API] Added the Add CustomerGroupAssignment, Remove CustomerGroupAssignment, and Set CustomerGroupAssignments update actions to the Customers API.
  • [API] Added the CustomerGroupAssignmentAdded, CustomerGroupAssignmentRemoved, and CustomerGroupAssignmentsSet Messages.
  • [API] Added the priceCustomerGroupAssignments field to the ProductSearchProjectionParams type.
  • [API] Added priceCustomerGroupAssignments and customerGroupAssignments as price selection parameters.
  • [API] Added customerGroupAssignments.customerGroup.id as a searchable field in Customer Search API.
  • [API] Added customer.customerGroupAssignments.customerGroup.id and customer.customerGroupAssignments.customerGroup.key as field identifiers for Customer on Cart Predicates.
  • [GraphQL API] Added the customerGroupAssignments field to the Customer type.
  • [GraphQL API] Added the customerGroupAssignments input field to the CustomerSignUpDraft type.
  • [GraphQL API] Added the addCustomerGroupAssignment, removeCustomerGroupAssignment, and setCustomerGroupAssignments input fields to the CustomerUpdateAction type.
  • [GraphQL API] Added the following types to the GraphQL schema: CustomerGroupAssignment, CustomerGroupAssignmentDraft, AddCustomerGroupAssignment, RemoveCustomerGroupAssignment, SetCustomerGroupAssignments, CustomerGroupAssignmentAdded, CustomerGroupAssignmentRemoved, CustomerGroupAssignmentsSet.
  • [GraphQL API] Added the customerGroupAssignmentIds argument to the ProductVariant.price field.

The following changes were introduced in terms of GraphQL SDL:

extend type Customer { "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" customerGroupAssignments: [CustomerGroupAssignment!] } extend input CustomerSignUpDraft { "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" customerGroupAssignments: [CustomerGroupAssignmentDraft!] } extend input CustomerUpdateAction { "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" addCustomerGroupAssignment: AddCustomerGroupAssignment "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" removeCustomerGroupAssignment: RemoveCustomerGroupAssignment "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" setCustomerGroupAssignments: SetCustomerGroupAssignments } "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" input AddCustomerGroupAssignment { customerGroupAssignment: CustomerGroupAssignmentDraft! } "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" type CustomerGroupAssignment { customerGroupRef: Reference customerGroup: CustomerGroup } "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" type CustomerGroupAssignmentAdded implements MessagePayload { customerGroupAssignment: CustomerGroupAssignment! type: String! } "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" input CustomerGroupAssignmentDraft { customerGroup: ResourceIdentifierInput! } "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" type CustomerGroupAssignmentRemoved implements MessagePayload { customerGroupAssignment: CustomerGroupAssignment! type: String! } "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" type CustomerGroupAssignmentsSet implements MessagePayload { customerGroupAssignments: [CustomerGroupAssignment!]! type: String! } "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" input RemoveCustomerGroupAssignment { customerGroup: ResourceIdentifierInput! } "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" input SetCustomerGroupAssignments { customerGroupAssignments: [CustomerGroupAssignmentDraft!]! }

Introduced Shopping Lists for Business Units

12 March 2025
Composable Commerce
HTTP API
Enhancement
B2BCustomersCartsGraphQL

You can now link a Shopping List to a Business Unit. Additionally, you can define permissions related to Shopping List for Associates assigned to the Business Unit and validate them using the new Associate Shopping Lists endpoints. This enhancement helps you, as merchants, to build flows that allows your B2B customers to create and collaborate on shopping lists.

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

Changes:

  • [API] Added businessUnit field to ShoppingList and ShoppingListDraft.
  • [API] Added the Set Business Unit update action to the Shopping Lists API.
  • [API] Added Associate Shopping Lists endpoints.
  • [API] Added Shopping List Permissions.
  • [GraphQL API] Added the businessUnit and businessUnitRef input fields to the ShoppingList type.
  • [GraphQL API] Added the businessUnit input field to the ShoppingListDraft type.
  • [GraphQL API] Added the setBusinessUnit input field to the ShoppingListUpdateAction type.
  • [GraphQL API] Added the SetShoppingListBusinessUnit type to the GraphQL schema.
  • [GraphQL API] Added the shoppingList and shoppingLists fields to the AsAssociate type.
  • [GraphQL API] AsAssociate object type now implements ShoppingListQueryInterface interface.
  • [GraphQL API] Added the asAssociate argument to the Mutation.createShoppingList field.
  • [GraphQL API] Added the asAssociate argument to the Mutation.updateShoppingList field.
  • [GraphQL API] Added the asAssociate argument to the Mutation.deleteShoppingList field.
  • [GraphQL API] Added the CreateMyShoppingLists, CreateOthersShoppingLists, DeleteMyShoppingLists, DeleteOthersShoppingLists, UpdateMyShoppingLists, UpdateOthersShoppingLists, ViewMyShoppingLists, and ViewOthersShoppingLists enum values to the Permission enum.

The following changes were introduced in terms of GraphQL SDL:

extend type AsAssociate { shoppingList( "Queries with specified ID" id: String "Queries with specified key" key: String ): ShoppingList shoppingLists( where: String sort: [String!] limit: Int offset: Int ): ShoppingListQueryResult! } extend enum Permission { CreateMyShoppingLists CreateOthersShoppingLists DeleteMyShoppingLists DeleteOthersShoppingLists UpdateMyShoppingLists UpdateOthersShoppingLists ViewMyShoppingLists ViewOthersShoppingLists } input SetShoppingListBusinessUnit { businessUnit: ResourceIdentifierInput! } extend type ShoppingList { businessUnit: BusinessUnit businessUnitRef: KeyReference } extend input ShoppingListDraft { businessUnit: ResourceIdentifierInput } extend input ShoppingListUpdateAction { setBusinessUnit: SetShoppingListBusinessUnit }

Added support to move Orders across Business Units

10 March 2025
Composable Commerce
HTTP API
Enhancement
B2BCustomersOrdersMessages/SubscriptionsGraphQL

You can now assign an Order to another Business Unit. This enhancement helps you reorganize historical orders when you restructure or adopt new Business Unit structures. This action will not trigger any revalidation of the fields or recalculation of the price or discount.

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

Changes:

  • [API] Added the Set Business Unit update action to Orders API.
  • [API] Added the Set Business Unit update action to Orders Edits API.
  • [API] Added the OrderBusinessUnitSet Message.
  • [GraphQL API] Added the following types to the GraphQL schema: OrderBusinessUnitSet, SetOrderBusinessUnit, SetStagedOrderBusinessUnit, SetStagedOrderBusinessUnitOutput.
  • [GraphQL API] Added the setBusinessUnit input field to OrderUpdateAction type.
  • [GraphQL API] Added the setBusinessUnit input field to StagedOrderUpdateAction type.

The following changes were introduced in terms of GraphQL SDL:

extend input StagedOrderUpdateAction { setBusinessUnit: SetStagedOrderBusinessUnit } extend input OrderUpdateAction { setBusinessUnit: SetOrderBusinessUnit } type OrderBusinessUnitSet implements MessagePayload & OrderMessagePayload { businessUnit: KeyReferenceInput oldBusinessUnit: KeyReferenceInput type: String! } input SetOrderBusinessUnit { businessUnit: ResourceIdentifierInput } input SetStagedOrderBusinessUnit { businessUnit: ResourceIdentifierInput } type SetStagedOrderBusinessUnitOutput implements StagedOrderUpdateActionOutput { type: String! businessUnitResId: ResourceIdentifier }

Announced deprecation of 'excludeCount' field

6 March 2025
Composable Commerce
HTTP API
Announcement
Deprecation
Pricing and DiscountsGraphQL
The excludeCount field in CountOnLineItemUnits and CountOnCustomLineItemUnits is now deprecated and will be removed on 6 June 2025. With this enhancement, by default, units of (Custom) Line Items matched in the CartDiscountPatternTarget triggerPattern are excluded and not considered for the targetPattern, on every application of the Discount.

Changes:

  • [API] Deprecated the excludeCount field in the CountOnLineItemUnits and CountOnCustomLineItemUnits types.
  • [GraphQL API] Deprecated the excludeCount field in the CountOnCustomLineItemUnits, CountOnCustomLineItemUnitsInput, CountOnLineItemUnits, and CountOnLineItemUnitsInput types.

Introduced endpoints to retrieve all roles and permissions of an Associate

6 March 2025
Composable Commerce
HTTP API
Enhancement
CustomersB2B

You can now retrieve all roles and permissions of an Associate within a Business Unit using a single query. This enhancement enables B2B merchants to efficiently fetch and validate buyer's associate permissions in their own applications, such as a B2B storefront. Previously, you could retrieve this information using multiple queries.

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 the Composable Commerce support team.

Changes:

Improved discount validation for Product and Cart Discounts

4 March 2025
Composable Commerce
HTTP API
Enhancement
Pricing and Discounts
To ensure discounts function as intended, we've implemented stricter validation for Product and Cart Discounts. An InvalidOperation error is now returned when you attempt to create an absolute Cart and Product Discount with an empty money value. Previously, discounts could be created without a money value, but they were never applied.

Added 'discountTypeCombination' field to Cart and Order

4 March 2025
Composable Commerce
HTTP API
Enhancement
Pricing and DiscountsGraphQL
We've introduced a new field, discountTypeCombination, that allows you to check how discounts apply and interact on a Cart and Order. Additionally, the new field also indicates the discount type chosen when the best deal logic applies to the Cart or Order.

Changes:

  • [API] Added the discountTypeCombination field to Cart and Order.
  • [API] Added DiscountTypeCombination, BestDeal, and Stacking types to Carts API.
  • [GraphQL API] Added the discountTypeCombination field to the Cart and Order types.
  • [GraphQL API] Added the following types to the GraphQL schema: DiscountTypeCombination, Stacking, BestDeal, ChosenDiscountType.
extend type Cart { discountTypeCombination: DiscountTypeCombination } extend type Order { discountTypeCombination: DiscountTypeCombination } "Chosen discount type for the cart as part of best deal" enum ChosenDiscountType { CartDiscount ProductDiscount } interface DiscountTypeCombination { type: String! } type Stacking implements DiscountTypeCombination { type: String! } type BestDeal implements DiscountTypeCombination { type: String! chosenDiscountType: ChosenDiscountType }

Apache HTTP clients update to version 5.4.1 is no longer required by March 1, 2025

21 February 2025
Composable Commerce
HTTP API
Announcement
General
Previously, we announced that Google plans to implement changes to the Google Cloud service that are incompatible with older Apache HTTP client versions. This change has been delayed until further notice.

Therefore, the previously communicated deadline of March 1, 2025, is no longer applicable. However, we still recommend that you update your Apache HTTP client.

Added support to filter Business Units by status using the Business Unit Search API

7 February 2025
Composable Commerce
HTTP API
Enhancement
B2BCustomersSearch
You can now filter Business Units by their status using the Business Unit Search API.
This feature is only available as part of Composable Commerce for B2B and will be subject to additional terms and pricing. To get access to Composable Commerce for B2B, contact the Composable Commerce support team.

Changes:

Apache HTTP clients must be updated to version 5.4.1 or newer

31 January 2025
Composable Commerce
HTTP API
Announcement
General
This change has been delayed until further notice.
Therefore, the deadline of March 1, 2025, as mentioned in this announcement, is no longer applicable. However, we still recommend that you update your Apache HTTP client.

In March 2025, Google plans to implement changes to the Google Cloud service that are incompatible with older Apache HTTP client versions.

Check your Apache HTTP client if you meet the following criteria:

  • Your commercetools Composable Commerce projects are hosted on GCP (Google Cloud).
  • You are using an Apache HTTP client to communicate with the Composable Commerce APIs.
  • Your Apache HTTP client is older than version 5.4.1.
  • Your Apache HTTP core component is older than version 5.3.1.

Added tutorial Modeling assortments with Product Selections

23 January 2025
Composable Commerce
HTTP API
Announcement
Product catalogProject configurationSearch
In the new tutorial Modeling assortments with Product Selections, users of Composable Commerce will learn:
  • How to use Product Selections and Stores to model assortments that you want to make available on your storefronts.
  • How to use Store-specific API clients to access only the products available in that Store.
  • How to include specific Product Variants in an assortment.
  • How to temporarily exclude entire Products from the assortment.
  • How to retrieve the Products in a Store using the Product Projection API and the Product Search API.

Fixed behavior of 'assets' and 'images' fields in Product Variant Tailorings

16 January 2025
Composable Commerce
HTTP API
Resolved issue
Product catalogGraphQL
We made the assets and images fields of entities related to Product Variant Tailoring optional to match the documented behavior.

Changes:

  • [API] Made the images field in the Set Images update action optional.
  • [GraphQL API] Made the images and oldImages fields in the ProductTailoringImagesSet type optional.
  • [GraphQL API] Made the images input field in the ProductTailoringImagesSet type optional.
  • [GraphQL API] Made the images and assets fields in the VariantTailoring and ProductVariantTailoring types optional.

Introduced Store-based data fencing for Business Units Search

15 January 2025
Composable Commerce
HTTP API
Enhancement
B2BCustomersSearch

You can now search by Stores and restrict results based on store-scoped tokens with Business Unit Search. This allows you, as merchants, to ensure that your internal users only have access to Business Units they're allowed to view and edit.

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

Added support for Product Variant Selections to Product Search in public beta

15 January 2025
Composable Commerce
HTTP API
Enhancement
Product catalogSearch
You can now retrieve Products assigned to Product Selections and Stores under consideration their Variant Selection through Product Search. Previously, you could retrieve only Products in Product Selections for the entire Product.

Introduced Store-based data fencing for Business Units

10 January 2025
Composable Commerce
HTTP API
Enhancement
B2BCustomersGraphQL
We have introduced in-store endpoints for Business Units. These endpoints give access only to Business Units associated with specific Stores. Additionally, the Business Units can now represent inherited Stores.
This feature is only available as part of Composable Commerce for B2B and will be subject to additional terms and pricing. To get access to Composable Commerce for B2B, contact the Composable Commerce support team.

Changes:

  • [API] Added in-store endpoints for Business Units.
  • [API] Added view_business_units:{projectKey}:{storeKey} and manage_business_units:{projectKey}:{storeKey} scopes.
  • [API] Added inheritedStores field to the BusinessUnit type.
  • [GraphQL API] Added the businessUnit field to the InStore type.
  • [GraphQL API] Added the storeKey argument to the Mutation.createBusinessUnit, Mutation.updateBusinessUnit, and Mutation.deleteBusinessUnit fields.

The following changes were introduced in terms of GraphQL SDL:

extend type InStore { businessUnit( "Queries with specified ID" id: String, "Queries with specified key" key: String): BusinessUnit businessUnits(where: String, sort: [String!], limit: Int, offset: Int): BusinessUnitQueryResult! }

Added filter for matching Product Variants in Product Projection Search in GraphQL

9 January 2025
Composable Commerce
HTTP API
Enhancement
Product catalogGraphQL
You can now control that only Product Variants that match the productProjectionSearch GraphQL query are included in the response. Previously, you had to filter for matching Product Variants on the client side.

Changes:

  • [GraphQL API] Added the onlyMatching argument to the ProductProjection.variants and the ProductProjection.allVariants field.

ImpEx is now deprecated

2 January 2025
Composable Commerce
HTTP API
Announcement
Deprecation
General
As announced previously, ImpEx is now deprecated effective 1 January 2025.
Replacement functionality, including import, export, the GraphQL Explorer, and the API Playgrounds, can be accessed in the Merchant Center. ImpEx CLI tools remain accessible but will no longer receive updates.

Added support for multiple values in 'exact' Product Search expressions in public beta

20 December 2024
Composable Commerce
HTTP API
Enhancement
Product catalogSearch
You can now provide multiple values in an exact expression in Product Search queries. This allows simpler query expressions to search for multiple values on the same field. Previously, you had to use an or compound expression to formulate such queries. The exact expression with multiple values helps reduce the number of expressions that count toward the 50-expression limit for queries.
  • [API] Added values field to exact query expression for Product Search in public beta.

Introduced Business Unit Search in beta

20 December 2024
Composable Commerce
HTTP API
New feature
B2BCustomersSearchGraphQL
The new Business Unit Search API allows merchants to search across a large number of Business Unit within a Project with improved performance and enhanced query capabilities. The API is intended for back-office use cases, not for searching business unit data in a storefront application. The API must be activated for the Project before it can be used.

Changes:

The following changes were introduced in terms of GraphQL SDL:

extend type SearchIndexingConfiguration { "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" businessUnits: BusinessUnitSearchConfiguration } extend input ProjectSettingsUpdateAction { "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" changeBusinessUnitSearchStatus: ChangeProjectSettingsBusinessUnitSearchStatus } "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" type BusinessUnitSearchConfiguration { status: BusinessUnitSearchStatus! lastModifiedAt: DateTime! lastModifiedBy: Initiator } "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" enum BusinessUnitSearchStatus { Activated Deactivated } "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" input ChangeProjectSettingsBusinessUnitSearchStatus { status: BusinessUnitSearchStatus! }

Added support to query all Product Variants in Product Projection Search in GraphQL

19 December 2024
Composable Commerce
HTTP API
Enhancement
Product catalogGraphQL
You can now fetch all Product Variants in productProjectionSearch queries in the GraphQL API. Previously, you had to use the masterVariant and variants separately to fetch all Product Variants.

Changes:

  • [GraphQL API] Added the allVariants field to the ProductProjection type.

The following changes were introduced in terms of GraphQL SDL:

extend type ProductProjection { "Fetch all variants, including the master variant in first position." allVariants: [ProductSearchVariant!]! }

Enhanced control over Discount interactions

19 December 2024
Composable Commerce
HTTP API
Enhancement
Pricing and Discounts

{/* vale Google.OxfordComma = NO */}

You can now control how Product and Cart Discounts interact, giving you greater flexibility in determining how Line Items are priced in a Cart. With this enhancement, Composable Commerce calculates a Cart total by applying Product and Cart Discounts separately to Line Items' prices and selecting the option that provides the lowest Cart total (best deal) for the customer.
This enhancement is available in public beta. Previously, Product and Cart Discounts always interacted, meaning Cart Discounts were calculated based on the already (Product) discounted price.

Added additional support for Custom Fields on Custom Shipping Method update actions

18 December 2024
Composable Commerce
HTTP API
Enhancement
CartsOrdersGraphQL
You can now pass Custom Fields when using the Set Custom Shipping Method update actions on Carts and Order Edits. For Carts, use the Set Custom ShippingMethod action, and for Order Edits, use either the Set Custom ShippingMethod action or the Set ShippingAddress and Custom ShippingMethod action.

Changes:

  • [API] Added optional custom field to Set Custom ShippingMethod on Carts.
  • [API] Added optional custom field to Set Custom ShippingMethod and Set ShippingAddress and Custom ShippingMethod on Order Edits.
  • [GraphQL API] Changed the SetCartCustomShippingMethod type:
    • Input field custom was added to SetCartCustomShippingMethod type
  • [GraphQL API] Changed the SetStagedOrderCustomShippingMethod type:
    • Input field custom was added to SetStagedOrderCustomShippingMethod type
  • [GraphQL API] Changed the SetStagedOrderShippingAddressAndCustomShippingMethod type:
    • Input field custom was added to SetStagedOrderShippingAddressAndCustomShippingMethod type
  • [GraphQL API] Changed the SetStagedOrderShippingAddressAndCustomShippingMethodOutput type:
    • Added the custom field to the SetStagedOrderShippingAddressAndCustomShippingMethodOutput type
  • [GraphQL API] Changed the SetStagedOrderCustomShippingMethodOutput type:
    • Added the custom field to the SetStagedOrderCustomShippingMethodOutput type

Product Tailoring of Attributes for Product Variants achieved general availability status

18 December 2024
Composable Commerce
HTTP API
Announcement
Product catalogGraphQL

After collecting feedback during the beta phase, we have moved Product Tailoring of Attributes for Product Variants out of beta.

Visit the API reference to learn more about how to customize attributes of Product Variants.

Added Messages for changes on Shopping Lists

18 December 2024
Composable Commerce
HTTP API
Enhancement
Messages/SubscriptionsGraphQL
You can now subscribe to Messages that are triggered when adding or removing a Line Item from a Shopping List.

Changes:

Added 'Canceled' ShipmentState to Orders

17 December 2024
Composable Commerce
HTTP API
Enhancement
OrdersGraphQL
We have added the Canceled option to ShipmentState. You can use this state in situations where you cannot deliver an order to a customer. Previously, this status could only be set using Custom Fields.

Changes:

  • [API] Added Canceled to ShipmentState enum.
  • [GraphQL API] Added the Canceled enum value to the ShipmentState enum.

Enhanced behavior for auto-deletion of Product Selection Assignments

17 December 2024
Composable Commerce
HTTP API
Enhancement
Product catalog
To ensure data integrity, we now automatically delete any Product Selection Assignment also when all Product Variants of a ProductVariantSelection have been removed from their Product. Previously, the automatic deletion of the Product Selection Assignment was only triggered when the SKU was removed from all Product Variants in a Product Selection Assignment.

Introduced 'CartDiscountPatternTarget' in beta

17 December 2024
Composable Commerce
HTTP API
Enhancement
Pricing and DiscountsAudit LogGraphQL
We've introduced a new target for Cart Discounts, CartDiscountPatternTarget, in public beta. This enhancement provides greater flexibility and control over discount configurations when setting up multi-purchase promotions, such as Buy One, Get One (BOGO), compared to Multibuy Discount target. Previously, with Multibuy discount target, you could only create a percentage-off discount and you could not repeat the discounts and apply them in the same order.

Changes:

The following changes were introduced in terms of GraphQL SDL:

"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" type CartDiscountPatternTarget implements CartDiscountTarget { triggerPattern: [PatternComponent!]! targetPattern: [PatternComponent!]! maxOccurrence: Int selectionMode: SelectionMode! type: String! } "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" input CartDiscountPatternTargetInput { triggerPattern: [PatternComponentInput!]! targetPattern: [PatternComponentInput!]! maxOccurrence: Int selectionMode: SelectionMode } extend input CartDiscountTargetInput { "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" pattern: CartDiscountPatternTargetInput } "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" type CountOnCustomLineItemUnits implements PatternComponent { predicate: String! minCount: Int maxCount: Int excludeCount: Int type: String! } "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" input CountOnCustomLineItemUnitsInput @ignoreDraftConventionValidation { predicate: String! minCount: Int = 1 maxCount: Int excludeCount: Int } "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" type CountOnLineItemUnits implements PatternComponent { predicate: String! minCount: Int maxCount: Int excludeCount: Int type: String! } "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" input CountOnLineItemUnitsInput @ignoreDraftConventionValidation { predicate: String! minCount: Int = 1 maxCount: Int excludeCount: Int } "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" interface PatternComponent { type: String! } "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" input PatternComponentInput { CountOnLineItemUnits: CountOnLineItemUnitsInput CountOnCustomLineItemUnits: CountOnCustomLineItemUnitsInput } extend input CartDiscountValueInput { fixedCart: FixedPriceCartDiscountValueInput } type FixedPriceCartDiscountValue implements CartDiscountValue { type: String! money: [BaseMoney!]! applicationMode: DiscountApplicationMode! } input FixedPriceCartDiscountValueInput { money: [CartDiscountValueBaseMoneyInput!]! applicationMode: DiscountApplicationMode! }

Added ability to retrieve and manage Channels by key

16 December 2024
Composable Commerce
HTTP API
Enhancement
Project configurationGraphQL
You can now retrieve, update, and delete Channels by user-defined key, and check for their existence by key.

Changes:

TypeScript SDK v2 client is now deprecated

30 October 2024
Composable Commerce
HTTP API
Deprecation
General
As announced previously, the v2 client of the TypeScript SDK is deprecated effective today.
The v2 client will not receive any future updates to fix bugs or security vulnerabilities. If you are currently using the v2 client, you should migrate to the v3 client.

Approval Rules can now be extended with Custom Fields

29 October 2024
Composable Commerce
HTTP API
Enhancement
B2BOrdersGraphQL
You can now extend the ApprovalRule resource with Custom Fields. This enhancement allows you to store custom data within your Approval Rule to better meet specific business requirements.

Changes:

  • [API] Added optional custom field to the ApprovalRule type.
  • [API] Added Set Custom Type and Set CustomField update actions to Approval Rules.
  • [API] Added approval-rule to CustomFieldReferenceValue enum.
  • [API] Added approval-rule to ResourceTypeId enum.
  • [GraphQL API] Added the following types to the GraphQL schema: SetApprovalRuleCustomField, SetApprovalRuleCustomType.
  • [GraphQL API] Changed the ApprovalRuleUpdateAction type:
    • Input field setCustomField was added to ApprovalRuleUpdateAction type
    • Input field setCustomType was added to ApprovalRuleUpdateAction type
  • [GraphQL API] Changed the ApprovalRule type:
    • Added the custom field to the ApprovalRule type.

Added the NewMasterVariantAdditionNotAllowed error code

22 October 2024
Composable Commerce
HTTP API
Enhancement
Product catalog
A new error code, NewMasterVariantAdditionNotAllowed, is returned when an import operation fails because a newly imported Product Variant is set as the Master Variant (isMasterVariant=true).

Only an existing Product Variant can be set as the Master Variant. To resolve the error, you can either update the existing Master Variant or create a new Product Variant and then set it as the Master Variant.

Changes:

Added endpoint for checking if ProductTailoring exists

18 October 2024
Composable Commerce
HTTP API
Enhancement
Product catalog
You can now check whether a ProductTailoring exists that matches a given Query Predicate. This new endpoint provides an efficient way to check if a Product Tailoring with specific conditions exists without retrieving the full data.

Changes:

Added sort capability for categoryOrderHints to Product Search

14 October 2024
Composable Commerce
HTTP API
Announcement
Product catalogSearch
The Product Search API now indexes the categoryOrderHints specified on Products. In combination with a filter on a category, you can now tell the API to sort the Product Search result by category order hint. This lets you present the products on a category page in the desired order.

Changes:

Customer Search achieved general availability status

1 October 2024
Composable Commerce
HTTP API
Announcement
CustomersSearchGraphQL
After collecting feedback during the beta phase, we have moved the Customer Search API out of beta into general availability.
The Customer Search API offers improved performance and enhanced query capabilities, supporting Projects with a large number of Customers. In addition to the Merchant Center, the feature is also intended to support other back-office applications you use. It is not intended for searching through customers in a storefront.

Changes:

  • [API] Added customers field to SearchIndexingConfiguration on Projects.
  • [API] Added the SearchNotReady error code.
  • [GraphQL API] Added the following types to the GraphQL schema: ChangeProjectSettingsCustomerSearchStatus, CustomerSearchConfiguration, CustomerSearchStatus.
  • [GraphQL API] Added the changeCustomerSearchStatus input field to the ProjectSettingsUpdateAction type.
  • [GraphQL API] Added the customers field to the SearchIndexingConfiguration type.

API Extensions now support Customer Groups

1 October 2024
Composable Commerce
HTTP API
Enhancement
CustomersExtensibility
You can now extend the Customer Group API with custom business logic using API Extensions. This feature allows you to trigger Extensions on create and update requests to Customer Groups. By using API Extensions, you can integrate with other services and implement custom use cases, modifying the default behavior of the APIs to suit your business needs.

Changes:

Introduced Product Tailoring of Attributes for Product Variants in public beta

26 September 2024
Composable Commerce
HTTP API
Enhancement
Product catalogGraphQL
We introduced Product Tailoring of Attributes in public beta. You can now customize product attributes for specific brands or countries, modeled with Stores, to enhance your product offering in different markets.

Changes:

Enhanced behavior of the image upload endpoint for Products and Product Tailoring

18 September 2024
Composable Commerce
HTTP API
Enhancement
Product catalog
As an evolution of a previous release, we enhanced the behavior of the image upload endpoints for the Product and Product Tailoring APIs to meet performance needs and improve the user experience.

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

  • A 200 OK response is returned when all sizes of the image have been successfully uploaded to the CDN.
  • A 202 Accepted response is returned when the small size of the image has been successfully uploaded to the CDN, but the upload of the other sizes is still ongoing. These other sizes will be available soon thereafter.
The response status code depends on the size of the original image. If the image is small, the API responds with 200 OK, and if the image is larger, it responds with 202 Accepted.
To ensure optimal performance, this change will not be applied to all Projects at once, but will be rolled out gradually over the next few weeks. Therefore, some Projects may still respond with a 200 OK status code after only the small image size has been successfully created.

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

Announcing deprecation of ImpEx

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

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

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

Product Tailoring of images and assets achieved general availability status

2 September 2024
Composable Commerce
HTTP API
Announcement
Product catalogGraphQL
After collecting feedback during the beta phase, we have moved Product Tailoring of images and assets out of beta and into general availability.
Visit the API reference to learn more about how to customize the images and assets of products for specific brands or regions.

Added discount distribution modes for absolute Cart Discounts

22 August 2024
Composable Commerce
HTTP API
Enhancement
Pricing and DiscountsGraphQL

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

Changes:

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

Added support for Custom Fields on Customers to Customer Search

20 August 2024
Composable Commerce
HTTP API
Enhancement
CustomersSearch
You can now search across all Customers using their Custom Fields, making it easier to find stored information.

Added Messages for changes on Custom Fields and Types on Order Deliveries

9 August 2024
Composable Commerce
HTTP API
Enhancement
Messages/SubscriptionsOrdersGraphQL
You can now subscribe to Messages for changes to Custom Fields and Types on Order Deliveries.

Changes:

The following changes were introduced in terms of GraphQL SDL:

Removed 'publish' field on EmbeddedPriceImport and ProductVariantImport

1 August 2024
Composable Commerce
HTTP API
Enhancement
Deprecation
Product catalogPricing and Discounts
As previously announced, we have now removed the publish field on EmbeddedPriceImport and ProductVariantImport.
Use the staged field to control whether the imported data should be applied to the current and/or staged representation of the Product.

Import API is now available on AWS in North America and Europe

30 July 2024
Composable Commerce
HTTP API
Announcement
General
The Import API is now available on AWS in North America and Europe, in addition to the existing Region available on Google Cloud Platform (GCP). For more information about hosts, see Hosts and Authorization.

API Extensions now support Shopping Lists

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

Changes:

Deprecation of the TypeScript SDK v2 client

26 July 2024
Composable Commerce
HTTP API
Enhancement
Deprecation
General

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

The v3 client is Promise-based and enhances overall performance and reliability. This includes adding support for advanced features such as the concurrent modification middleware.
We will deprecate the v2 client on 30 October 2024. For more information on the differences between the v2 and v3 clients, see Migrate to the v3 client.

Added capability to query Shopping Lists by TextLineItem key

22 July 2024
Composable Commerce
HTTP API
Enhancement
Carts
You can now filter Shopping Lists by TextLineItem key in queries.

Changes:

Added support for changing Line Items' order on Carts

18 July 2024
Composable Commerce
HTTP API
Enhancement
CartsGraphQL

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

Changes:

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

Added Cart Predicate field identifier 'store.key'

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

Changes:

Added 'active' field to Shipping Methods

12 July 2024
Composable Commerce
HTTP API
Enhancement
OrdersGraphQL
We've added the active field to ShippingMethod. With this addition, you can now activate or deactivate individual Shipping Methods, as needed. This change helps you to manage Shipping Methods more efficiently by allowing you to temporarily deactivate them when not in use. Previously, you had to remove the Shipping Methods and create them again.
For all existing Shipping Methods, the active field has been set to true. Now, when you create or update a Cart or Order, you can only use an active Shipping Method.

Changes:

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

Added 'addressId' field to Messages related to changes on Custom Fields of Addresses

10 July 2024
Composable Commerce
HTTP API
Enhancement
B2BCustomersMessages/SubscriptionsGraphQL

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

Changes:

Added Cart Predicate field identifier 'origin'

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

Changes:

Added Messages for changes on Custom Fields and Types on Embedded Prices

2 July 2024
Composable Commerce
HTTP API
Enhancement
Pricing and DiscountsMessages/SubscriptionsGraphQL
You can now subscribe to Messages for changes to Custom Fields and Types on Embedded Prices.

Changes:

Business Units now support Approval Rules inheritance

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

Changes:

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

Introduced Product Tailoring of images and assets in beta

27 June 2024
Composable Commerce
HTTP API
Enhancement
Product catalogGraphQLMessages/Subscriptions
We introduced Product Tailoring of images and assets in public beta. You can now customize product images and assets for specific brands or countries, modeled with Stores, to enhance your product offering in different markets.

Changes:

Introduced Customer Search in beta

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

Changes:

Product Search achieved general availability status

26 June 2024
Composable Commerce
HTTP API
Announcement
Product catalogSearch
After collecting feedback during the beta phase, we have moved the Product Search API out of beta into general availability.
With the Product Search API, you can create performant storefront search experiences for your products across Stores and Product Selections to enhance product discoverability. Standalone Prices are taken into account for sorting, filtering, and faceting.
The API's search query language supports compound expressions like AND, OR, NOT, and filter. This allows you, for instance, to filter out specific products from search results or display products based on color criteria, including those with or without a color attribute.
Find a comparison between the Product Search API and the Product Projection Search API on the Storefront search overview page.
Following features of the API remain in public beta:

Introduced support for Private Service Connect

26 June 2024
Composable Commerce
HTTP API
New feature
Security and privacy

{/* vale commercetools.Acronyms = NO */}

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

Introduced Store-based data fencing for Quotes

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

Changes:

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

Added support for Custom Fields on PaymentInfo to Order Search

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

Changes:

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

Product Tailoring achieved general availability status

3 June 2024
Composable Commerce
HTTP API
Announcement
Product catalog
After collecting feedback during the beta phase, we have moved Product Tailoring out of beta and into general availability.
Visit the API reference to learn more about how to customize product details for specific brands or regions.

Improved logic of the success response for the upload of Product images

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

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

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

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

Increased the limit of Customer Groups in a Project to 10,000

2 May 2024
Composable Commerce
HTTP API
Enhancement
CustomersLimits

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

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

Added 'staged' field and deprecated 'publish' field on EmbeddedPriceImport and ProductVariantImport

24 April 2024
Composable Commerce
HTTP API
Enhancement
Deprecation
Product catalogPricing and Discounts
To simplify the process of importing Embedded Prices and Product Variants, we have added the staged field to EmbeddedPriceImport and ProductVariantImport. With this new staged field you can control whether the imported data should be applied to the current and/or staged representation of the Product to update.
The staged field replaces the publish field, which is now deprecated and will be removed on 1 August 2024.
This change brings the Import API in line with the HTTP API by using the same fields for the same purpose. If you are using the publish field to import Embedded Prices and Product Variants, you should use staged instead and adjust the value based on your use case.

Changes:

Postponed changes to publishing Products using the Import API

19 April 2024
Composable Commerce
HTTP API
Announcement
Deprecation
Product catalog
As previously announced, we will change the behavior of the publish field when importing Product data. This change helps you to prevent accidental publishing of Products, which can negatively impact customer satisfaction and brand reputation due to poor/incomplete product information, or can lead to the premature exposure of products to customers.

As this may break existing implementations, we have postponed the implementation to 1 August 2024. This gives you additional time to prepare for this change.

Please reach out to your contact at commercetools if you have any questions.

Announcing changes to how the Import API publishes Products

8 April 2024
Composable Commerce
HTTP API
Announcement
Product catalog
On 1 August 2024*, we will change the behavior of the publish field when importing Product data. The following changes will reduce the complexity of importing Product data, and will prevent unintended publishing:
  • You can only use the publish field to publish or unpublish Products when importing Products or Product drafts.
  • When importing Embedded Prices, Product Variants, or [Product Variant Patches]/../api/import-export/product-variant-patch):
    • If a Product is currently unpublished, then it will not be published even if publish is true.
    • The Product's current projection will not be replaced by the staged projection.
*The original date of this change was 22 April 2024. We have extended the date to give users additional time to adapt to this change.

Added attribution in Client Logging

5 April 2024
Composable Commerce
HTTP API
Enhancement
Security and privacyGraphQL

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

Changes:

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

Added Import Discount Codes endpoint in beta

4 April 2024
Composable Commerce
HTTP API
New feature
Pricing and Discounts
We have added the Import Discount Codes endpoint to the Import API. This new feature allows you to bulk import Discount Codes to your Composable Commerce Project.

You can now send us the whole Discount Code snapshot and we will create/update resources in your Project by calculating the delta.

Changes:

Introduced Product Search in beta

26 March 2024
Composable Commerce
HTTP API
New feature
Product catalogSearchProject configuration
With the new Product Search API, you can create performant storefront search experiences for your products across Stores, Product Selections, and Standalone Prices to enhance product discoverability.
The API includes enhanced query capabilities, including compound expressions, such as AND, OR, NOT, and filter. This functionality enables you to, for instance, filter out specific products from search results or display products based on color criteria, including those with or without a color attribute.
For different types of attributes, prefix search is provided to support partial matches on Products with similar Product keys, for instance.
You can now perform full-text searches on a specific field only, instead of searching through all indexed product data. You didn't have this option before with the Product Projection Search API.

Changes:

Introduced 'ManuallySuspended' health status for Subscriptions

26 March 2024
Composable Commerce
HTTP API
Enhancement
Messages/SubscriptionsGraphQL
A new ManuallySuspended health status has been introduced for Subscriptions.
This status solves an issue where, after fixing a problem that caused the health status to keep switching between Healthy to ConfigurationErrorDeliveryStopped, you needed to delete and recreate a Subscription. Now when the issue is resolved, the Composable Commerce support team can manually change the status to Healthy again, so you no longer need to delete and recreate the Subscription.
A Subscription is changed to the ManuallySuspended status when there is an issue with the Destination queue. The Subscription does not automatically return to a Healthy status. You must contact the Composable Commerce support team to manually change the status to Healthy again.

Changes:

Order Edits achieved general availability status

15 March 2024
Composable Commerce
HTTP API
Announcement
Orders
After collecting feedback during the beta phase, we have moved Order Edits out of beta and into general availability.
Order Edits differ from direct updates to Orders. You can use Order Edits to make financial changes to the purchase agreement after Order placement. For example, if you need to modify the quantity of a Line Item, thereby affecting the Order total.

Fixed tax subrate calculation for Line Items and Custom Line Items

7 March 2024
Composable Commerce
HTTP API
Resolved issue
CartsOrders

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

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

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

Added 'taxPortions' field to TaxedItemPrice

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

Changes:

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

Introduced Product Tailoring in beta

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

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

Changes:

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

Added support for key and Messages for Discount Codes

7 February 2024
Composable Commerce
HTTP API
Enhancement
Pricing and DiscountsMessages/SubscriptionsGraphQL
You can now use user-defined key values to identify Discount Codes. Previously, you could identify them only by their auto-generated IDs. The enhancement also includes a new update action to set the key value, allowing you to update Discount Code keys efficiently without the need to bulk import Discount Codes with the updated keys.
Additionally, this enhancement also adds support for Messages for Discount Codes. You can subscribe to these Messages for changes when creating, deleting, or setting a key value for a Discount Code.

Changes:

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

Introducing commercetools Foundry

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

What's included:

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

AuthenticationMode on Customer achieved general availability status

12 January 2024
Composable Commerce
HTTP API
Announcement
Customers
After collecting feedback during the beta phase, we have moved AuthenticationMode out of beta. The status of the following features has been changed to general availability:

Added Messages for changes on Cart Discounts

12 January 2024
Composable Commerce
HTTP API
Enhancement
Pricing and DiscountsMessages/SubscriptionsGraphQL
You can now subscribe to Messages that will be triggered when creating and deleting a Cart Discount, and when using the Add Store, Remove Store, and Set Stores actions on Cart Discounts.

Changes:

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

Approval Flows can now be extended with Custom Fields

11 January 2024
Composable Commerce
HTTP API
Enhancement
B2BOrdersGraphQL
You can now extend the ApprovalFlow resource with Custom Fields. With this, you can add meta-information to your Approval Flow in case it is required for your business logic.

Changes:

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

Buyer Approval Flows achieved general availability status

10 January 2024
Composable Commerce
HTTP API
Announcement
B2BOrders
After collecting feedback during the beta phase, we have moved Buyer Approval Flows out of beta. The status of the following features has been changed to general availability:
  • Approval Rules, which define the conditions under which an Order must go through an approval process.
  • Approval Flows, which manage the overall state of the approval process.
These features are only available as part of Composable Commerce for B2B and will be subject to additional terms and pricing. To get access to Composable Commerce for B2B, contact the Composable Commerce support team.

Deprecation of Java v1 SDK

2 January 2024
Composable Commerce
HTTP API
Announcement
Deprecation
General
As announced previously in our long-term support plan for Composable Commerce SDKs, Version 1 (v1) of our Java SDK is now deprecated effective 1 January 2024.
The Java v1 SDK will not receive any future updates to fix bugs or security vulnerabilities. If you are currently using the Java v1 SDK, you should migrate to the Java v2 SDK.

VPC Service Controls for Google Cloud Pub/Sub and Google Cloud Functions

22 December 2023
Composable Commerce
HTTP API
Enhancement
Security and privacyExtensibilityMessages/Subscriptions

{/* vale commercetools.Acronyms = NO */}

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

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

We recommend enabling VPC Service Controls for:

Store-specific Cart Discounts achieved general availability status

13 December 2023
Composable Commerce
HTTP API
Announcement
Pricing and DiscountsProject configurationSecurity and privacy
After collecting feedback during the beta phase, we have moved Store-specific Cart Discounts out of beta. The status of the following features has been changed to general availability:
This feature lets you build Cart Discounts specific to a Store to model, for example, customer-specific or brand-specific cart discounts. To know more about Cart Discounts, see the Cart Discounts API.

Cart total discount achieved general availability status

12 December 2023
Composable Commerce
HTTP API
Announcement
Pricing and DiscountsCartsOrdersGraphQL
After collecting feedback during the beta phase, we have moved Cart total price discount target out of beta. The status of the following features has been changed to general availability:
This feature lets you build cart discounts targeting the total price of a cart, for example, get 5$ off your cart total. To know more about cart discounts, see Cart Discounts API.

API Extensions achieved general availability status

5 December 2023
Composable Commerce
HTTP API
Announcement
Extensibility
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.

Updated structure for HTTP API documentation

23 November 2023
Composable Commerce
HTTP API
Announcement
General

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.

Updated the implementation of SetNameChange in Audit Log

18 October 2023
Composable Commerce
HTTP API
Announcement
Deprecation
Audit Log
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:
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:
  • [API] Added support for the Set Name update action on Associate Roles to the Change History API.

Added new endpoints for checking if a resource exists

18 October 2023
Composable Commerce
HTTP API
Enhancement
General
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.

Added CustomerEmailTokenCreated and CustomerPasswordTokenCreated Messages

6 October 2023
Composable Commerce
HTTP API
Enhancement
Messages/SubscriptionsCustomersGraphQL
You can now subscribe to Messages for email verification and password reset tokens of Customers.

Changes:

Fixed field types on OrderFromCartDraft, OrderFromQuoteDraft, and PaymentDraft

2 October 2023
Composable Commerce
HTTP API
Resolved issue
GraphQLOrdersQuotesPayments
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

Added 'product' field to ProductVariantPatch

29 September 2023
Composable Commerce
HTTP API
Announcement
Product catalog
We introduced the product field on ProductVariantPatch. This field allows you to reference the Product which contains the Product Variant, and batches import operations to help prevent concurrency errors.

Changes:

Product Selections of mode Exclusion achieved general availability status

29 September 2023
Composable Commerce
HTTP API
Announcement
Product catalogProject configurationMessages/SubscriptionsGraphQL
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:
To learn more about managing assortments with Product Selections, see Product Selections API.

Added support for discounting the Cart total

28 September 2023
Composable Commerce
HTTP API
Enhancement
Pricing and DiscountsCartsOrdersGraphQL
You can now create Cart Discounts that target the total price of a Cart. With this enhancement, you can configure promotions such as spend 200€ and get 5€ off the cart total. Previously, this discount configuration was not supported.

Changes:

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

Introduced Buyer Approval Flows in beta

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

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

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

Changes:

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

Added Messages for changes on Custom Fields and Types on Customer Groups

18 September 2023
Composable Commerce
HTTP API
Enhancement
CustomersMessages/SubscriptionsGraphQL
You can now subscribe to Messages for changes to Custom Fields and Types on Customer Groups.

Changes:

Get ProductProjection in Store endpoints achieved general availability status

15 September 2023
Composable Commerce
HTTP API
Announcement
Project configurationProduct catalog
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:
To learn how Stores can enable filtering of data in Product Projections, see Stores API.

Audit Log now identifies changes linked to a specific Business Unit for Orders, Quote Requests, and Quotes.

13 September 2023
Composable Commerce
HTTP API
Enhancement
B2BAudit LogQuotesOrdersGraphQL
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.

Added Cart Predicate functions 'shippingInfoExists' and 'forAllShippingInfos'

13 September 2023
Composable Commerce
HTTP API
Enhancement
CartsOrders
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.

Added Messages for changes on Custom Fields and Types on Business Units

8 September 2023
Composable Commerce
HTTP API
Enhancement
B2BCustomersMessages/SubscriptionsGraphQL
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:

Added Messages for changes on Custom Fields and Types on Customers and Customer Addresses

1 September 2023
Composable Commerce
HTTP API
Enhancement
CustomersMessages/SubscriptionsGraphQL
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:

Added support for creating and deleting staged values in Standalone Prices

31 August 2023
Composable Commerce
HTTP API
Enhancement
Pricing and DiscountsGraphQL

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.

Quotes achieved general availability status

29 August 2023
Composable Commerce
HTTP API
Announcement
QuotesB2BOrders
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:
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

Added 'perMethodExternalTaxRate' field to LineItemDraft

25 August 2023
Composable Commerce
HTTP API
Enhancement
CartsOrdersGraphQL
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.

Added GraphQL support for Messages on QuoteRequests, StagedQuotes, and Quotes

24 August 2023
Composable Commerce
HTTP API
Enhancement
GraphQLB2BQuotesMessages/Subscriptions
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.

Added GraphQL support for querying Quotes and Quote Requests as an Associate

23 August 2023
Composable Commerce
HTTP API
Enhancement
GraphQLB2BQuotes
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

Business Units achieved general availability status

21 August 2023
Composable Commerce
HTTP API
Announcement
B2BCartsOrdersQuotesCustomersGraphQL
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:
These features are only available as part of Composable Commerce for B2B and will be subject to additional terms and pricing. To get access to Composable Commerce for B2B, contact the Composable Commerce support team.

Audit Log now identifies changes made by Associates on Business Units, Orders, Quote Requests, and Quotes.

21 August 2023
Composable Commerce
HTTP API
Enhancement
B2BAudit LogCustomersQuotesOrdersGraphQL
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.

Introduced 'cart' field on QuoteRequest

21 August 2023
Composable Commerce
HTTP API
Enhancement
QuotesGraphQL
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.

Introduced 'key' field on ShoppingListLineItem and TextLineItem

11 August 2023
Composable Commerce
HTTP API
Enhancement
GraphQLCarts
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:

Removed deprecated ProductSelectionType

4 August 2023
Composable Commerce
HTTP API
Enhancement
Deprecation
Product catalogGraphQL
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.

Added 'taxedPricePortions' field to CustomLineItem

4 August 2023
Composable Commerce
HTTP API
Enhancement
CartsOrdersGraphQL
We introduced the taxedPricePortions field on CustomLineItem to add additional support for Carts containing multiple Shipping Methods.

Changes:

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

Removed deprecated roles on Associates in Business Units

2 August 2023
Composable Commerce
HTTP API
Announcement
Deprecation
B2B
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.

Added Messages for changes on Custom Fields and Types on Orders

1 August 2023
Composable Commerce
HTTP API
Enhancement
OrdersMessages/SubscriptionsGraphQL
You can now subscribe to Messages that will be triggered when using Set CustomField and Set Custom Type actions on Orders.

Changes:

Changed EmbeddedPriceDraftImport key field to be required

31 July 2023
Composable Commerce
HTTP API
Announcement
Product catalog
As announced before, we have now changed the key field on EmbeddedPriceDraftImport to be required.
You must now include a value for key in EmbeddedPriceDraftImport when importing Embedded Prices using the Import Product drafts endpoint.

Changes:

Introduced 'key' field on Return Items

31 July 2023
Composable Commerce
HTTP API
Enhancement
GraphQLOrders
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:

Added support for high precision money on fixed price Cart Discounts

31 July 2023
Composable Commerce
HTTP API
Enhancement
Pricing and DiscountsGraphQL

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!]!

Added Get QuoteRequest endpoints to My Quote Requests

24 July 2023
Composable Commerce
HTTP API
Enhancement
B2BQuotes

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

Changes:

Introduced 'customLineItemKey' field on Orders Messages and update actions

21 July 2023
Composable Commerce
HTTP API
Enhancement
GraphQLOrdersMessages/Subscriptions
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:

Addresses field is now optional on Customer Import

18 July 2023
Composable Commerce
HTTP API
New feature
Customers
The addresses field in CustomerImport on the Import Customers endpoint has changed from required to optional. This change aligns the Import API with the HTTP API and makes it easier for users to create and update Customers with the Import API.

Audit Log now tracks changes on Associate Roles

18 July 2023
Composable Commerce
HTTP API
Enhancement
Deprecation
B2BAudit LogGraphQL
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:

Changes:

Added ChangeSubscriptions for Associate Roles

14 July 2023
Composable Commerce
HTTP API
New feature
B2BCustomersMessages/Subscriptions
You can now subscribe to notifications about changes to Associate Roles.
This feature is only available as part of Composable Commerce for B2B and will be subject to additional terms and pricing. To get access to Composable Commerce for B2B, contact the Composable Commerce support team.

Changes:

Enhanced Client Logging to include changes of Associates

14 July 2023
Composable Commerce
HTTP API
Enhancement
B2BCustomers
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.

Introduced 'lineItemKey' field on Messages related to Order Line Items

14 July 2023
Composable Commerce
HTTP API
Enhancement
OrdersMessages/SubscriptionsGraphQL
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:

Introduced 'customLineItemKey' field on update actions related to CustomLineItem

12 July 2023
Composable Commerce
HTTP API
Enhancement
CartsOrdersGraphQL
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:

Extended the date when the EmbeddedPriceDraftImport key field changes from optional to required

11 July 2023
Composable Commerce
HTTP API
Announcement
Pricing and Discounts
As announced before, the key field on EmbeddedPriceDraftImport is changing from optional to required.
The effective date of this change has been extended to 31 July 2023. This extension provides users with additional time to make necessary updates to accommodate this change.

Introduced Store-specific Cart Discounts in beta

5 July 2023
Composable Commerce
HTTP API
Enhancement
Pricing and DiscountsProject configurationSecurity and privacy
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).

Introduced 'key' field on CustomLineItem

3 July 2023
Composable Commerce
HTTP API
Enhancement
CartsOrdersGraphQL
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.

Audit Log AWS Regions achieved general availability status

30 June 2023
Composable Commerce
HTTP API
Announcement
Audit Log
After collecting feedback during the beta phase, we have moved all AWS Regions out of beta and into general availability.

Increased the limit of Associates in a Business Unit to 2000

30 June 2023
Composable Commerce
HTTP API
Enhancement
B2BLimits
A Business Unit can now contain up to 2000 Associates. This is an increase from the previous limit of 100.

Removed deprecated names of Product Variant Selection types

30 June 2023
Composable Commerce
HTTP API
Announcement
Deprecation
Product catalogGraphQL
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.

Audit Log now tracks changes on Business Units

29 June 2023
Composable Commerce
HTTP API
Enhancement
B2BAudit LogProduct catalogQuotesProject configurationGraphQL
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:

The following change was introduced in terms of GraphQL SDL:

Staged and active Standalone Prices achieved general availability status

27 June 2023
Composable Commerce
HTTP API
Announcement
Pricing and DiscountsMessages/Subscriptions
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:

Added 'lineItemKey' to Cart, Order, and Order Edit update actions

23 June 2023
Composable Commerce
HTTP API
Enhancement
CartsOrdersGraphQL
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:

Fixed 'InventoryEntryCreated' type in the GraphQL API

23 June 2023
Composable Commerce
HTTP API
Resolved issue
GraphQLProduct catalogMessages/Subscriptions
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!

Added 'perMethodTaxRate' field to CustomLineItems

22 June 2023
Composable Commerce
HTTP API
Enhancement
CartsOrdersGraphQL
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.

Added 'sku' field to Standalone Price Deleted Message

20 June 2023
Composable Commerce
HTTP API
Enhancement
Messages/SubscriptionsPricing and DiscountsGraphQL
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.

Added update actions to set Price tiers on Standalone Prices

20 June 2023
Composable Commerce
HTTP API
Enhancement
Pricing and DiscountsGraphQL
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:

Removed deprecated fields from Remove Price update action

15 June 2023
Composable Commerce
HTTP API
Enhancement
Deprecation
Pricing and DiscountsGraphQL
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.

Added update actions to set validity dates on Standalone Prices

12 June 2023
Composable Commerce
HTTP API
Enhancement
Pricing and DiscountsGraphQL
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:

Added 'key' to Cart Line Item

9 June 2023
Composable Commerce
HTTP API
Enhancement
CartsGraphQL
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

Confluent Cloud added as Subscription destination

7 June 2023
Composable Commerce
HTTP API
Enhancement
Messages/Subscriptions
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

Added 'business-unit' and 'associate-role' to CustomFieldReferenceValue

7 June 2023
Composable Commerce
HTTP API
Enhancement
ExtensibilityB2B
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:

Introduced GraphQL support for creating Associates using My Business Units

6 June 2023
Composable Commerce
HTTP API
Enhancement
B2BGraphQL
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.

Introduced 'key' field on Parcel

6 June 2023
Composable Commerce
HTTP API
Enhancement
OrdersGraphQL
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:
  • [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.

Added update action for setting the InventoryMode of Line Items

2 June 2023
Composable Commerce
HTTP API
Enhancement
CartsGraphQLProduct catalog
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

Added RenegotiationAddressed state to QuoteState

2 June 2023
Composable Commerce
HTTP API
Enhancement
QuotesGraphQL
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

Countries on Stores achieved general availability status

31 May 2023
Composable Commerce
HTTP API
Announcement
Project configurationMessages/Subscriptions
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:
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.

Added the MoneyOverflow error code

30 May 2023
Composable Commerce
HTTP API
Enhancement
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:

Attribute Groups achieved general availability status

30 May 2023
Composable Commerce
HTTP API
Announcement
Product catalog
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:
Attribute Groups let you organize Attribute Definitions by providing a list of references to Product Attributes. Learn more by visiting our documentation page.

Direct Discounts achieved general availability status

26 May 2023
Composable Commerce
HTTP API
Enhancement
CartsOrdersGraphQL
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:

Added support for updating a Customer on Quotes and Quote Requests

26 May 2023
Composable Commerce
HTTP API
Enhancement
GraphQLB2BQuotes
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

Added Replicate Cart in Business Unit endpoint

25 May 2023
Composable Commerce
HTTP API
Enhancement
B2BCarts
You can now replicate Carts in a given Business Unit using the Associate Carts endpoint.

Added support for external tax on multiple Shipping Methods

25 May 2023
Composable Commerce
HTTP API
Enhancement
CartsOrdersGraphQL
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:
  • [API] Added the shippingKey field to the following update actions on Order Edits:
  • [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.

commercetools Composable Commerce for China is now available on AWS Ningxia

23 May 2023
Composable Commerce
HTTP API
Announcement
General

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.

Added observability to Composable Commerce SDKs

23 May 2023
Composable Commerce
HTTP API
Announcement
General
We have added support for New Relic to Composable Commerce SDKs.

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

With this update, you can:

  • Trace and profile application performance directly from the SDK.
  • View and analyze your application's performance.
  • Get real-time insights and alerts about your application's performance and issues.
New Relic is currently supported by the latest versions of the Java SDK, TypeScript SDK, PHP SDK, and .NET SDK.

Introduced 'key' field on Delivery

17 May 2023
Composable Commerce
HTTP API
Enhancement
OrdersGraphQL
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:
  • [API] Added the deliveryKey field to the following update actions on Order Edits:
  • [API] Changed the deliveryId field to be optional on the following update actions on Orders:
  • [API] Changed the deliveryId field to be optional on the following update actions on Order Edits:
  • [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

Announced deprecation of 'sku', 'variantId' and 'price' fields in Remove Price update action

17 May 2023
Composable Commerce
HTTP API
Announcement
Deprecation
Pricing and DiscountsGraphQL
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

Added Product Projections on locales to the GraphQL API

16 May 2023
Composable Commerce
HTTP API
Enhancement
GraphQLProduct catalogProject configuration
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

Added Type import endpoint

12 May 2023
Composable Commerce
HTTP API
New feature
Extensibility
We have added the Type endpoint to the Import API. This new feature allows you to bulk import Types to your Composable Commerce Project for modeling Custom Fields.

You can now send us the whole Type snapshot and we will create/update the entry in your Project by calculating the delta.

Changes:

Changed the fields ‘BusinessUnit.associateMode’, ‘Associate.associateRoleAssignments’, and ‘AssociateRoleAssignment.inheritance’ to be mandatory in responses

12 May 2023
Composable Commerce
HTTP API
Enhancement
B2BGraphQL
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!

Added AssociateMissingPermissionError for Associate Roles

10 May 2023
Composable Commerce
HTTP API
Enhancement
B2BSecurity and privacy
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:

Added 'inheritedStores' field to Business Units in GraphQL

5 May 2023
Composable Commerce
HTTP API
Enhancement
GraphQLB2B
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.

Enhanced permissions management for companies

2 May 2023
Composable Commerce
HTTP API
New feature
Deprecation
B2BCustomersCartsOrdersQuotesGraphQL
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

Product Selections achieved general availability status

19 April 2023
Composable Commerce
HTTP API
Announcement
Product catalog
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:
Product Selections can be used to manage individual assortments for different sales channels and Stores. Learn more by visiting our documentation page.

Replaced ProductSelectionType with ProductSelectionMode

18 April 2023
Composable Commerce
HTTP API
Announcement
Deprecation
Product catalogGraphQL
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 available for AWS Regions in beta

13 April 2023
Composable Commerce
HTTP API
Announcement
Audit Log
Audit Log is now available in AWS Regions in beta.

Added 'shippingCustomFields' and 'shippingKey' fields on Cart and Order

13 April 2023
Composable Commerce
HTTP API
Enhancement
CartsOrdersGraphQL
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.

EmbeddedPriceDraftImport key field changing from optional to required

11 April 2023
Composable Commerce
HTTP API
Announcement
Pricing and Discounts
To enhance the performance and reliability of the Import API, we are changing the key field on EmbeddedPriceDraftImport from optional to required.
This change will take effect on 31 July 2023*. From this date, you must include a key when importing Prices using EmbeddedPriceDraftImport.
*The original date of this change was 11 July 2023. The date was extended to provide users with additional time to make necessary updates to accommodate this change.

Introduced 'key' field on TaxRate

4 April 2023
Composable Commerce
HTTP API
Enhancement
Pricing and DiscountsGraphQL
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

Fixed Reference Expansion input types for Business Unit Messages in the GraphQL API

28 March 2023
Composable Commerce
HTTP API
Resolved issue
GraphQLB2B
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.

Introduced Product Selection of type Individual Exclusion in Beta

17 March 2023
Composable Commerce
HTTP API
Enhancement
Product catalogProject configurationMessages/SubscriptionsGraphQL
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.

Fixed type for 'state' field in PaymentStatusDraft

16 March 2023
Composable Commerce
HTTP API
Resolved issue
GraphQLPayments
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.

Changed names of Product Variant Selection types

6 March 2023
Composable Commerce
HTTP API
Announcement
Deprecation
Product catalogGraphQL
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.

External OAuth achieved general availability status

2 March 2023
Composable Commerce
HTTP API
Announcement
Security and privacy
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:

Added support for AuthenticationMode in Customer import and support for Custom Fields and State in Order import fields.

1 March 2023
Composable Commerce
HTTP API
New feature
OrdersCustomers
You can now import Customers with an AuthenticationMode to determine if they should use a password or external authentication. The addition of AuthenticationMode also means that passwords are no longer mandatory when importing Customers.
Order Import can also now include Custom Fields on their shippingAddress, and Parcels fields.
State is also now available for import in Order Import.

These additions provide more options and greater flexibility when importing Customers and Orders.

Changes:

Introducing Google Cloud Function destination for API Extensions

17 February 2023
Composable Commerce
HTTP API
Enhancement
ExtensibilityGraphQL

{/* vale commercetools.Acronyms = NO */}

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.

Improvements to working with Business Units in the GraphQL API

10 February 2023
Composable Commerce
HTTP API
Enhancement
GraphQLQuotesB2B
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

Added 'discounted' field to 'ProductPriceDataInput' type in GraphQL

7 February 2023
Composable Commerce
HTTP API
Enhancement
GraphQLPricing and Discounts
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!.

Added 'oldValue' field to Standalone Price Value Changed Message

6 February 2023
Composable Commerce
HTTP API
Enhancement
Messages/SubscriptionsPricing and DiscountsGraphQL
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.

CloudEventsFormat achieved general availability status

1 February 2023
Composable Commerce
HTTP API
Announcement
Messages/Subscriptions
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.

Added GraphQL support for multiple shipping methods

31 January 2023
Composable Commerce
HTTP API
Enhancement
CartsOrdersGraphQL
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.

Added 'purchaseOrderNumber' field to Quotes- and Order-related types

26 January 2023
Composable Commerce
HTTP API
Enhancement
QuotesOrdersGraphQL
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.

Automatic updates of SKU changes in Product Selection Assignments

24 January 2023
Composable Commerce
HTTP API
Announcement
Product catalog
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.

Discontinued support for IronMQ

12 January 2023
Composable Commerce
HTTP API
Announcement
Deprecation
Messages/Subscriptions
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.

Retrieve applicable Shipping Methods for a Cart and Location

21 December 2022
Composable Commerce
HTTP API
New feature
Carts
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 Extensions for AWS Lambda destinations now support the use of function aliases

16 December 2022
Composable Commerce
HTTP API
Enhancement
Extensibility
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:

Introducing pattern and length validation for keys of Embedded Prices and Standalone Prices

14 December 2022
Composable Commerce
HTTP API
Enhancement
Pricing and Discounts
As we have recently introduced a key field on Embedded Prices, we have aligned pattern and length constraints accordingly so that there are no inconsistencies for imported Prices.
Values for the key field in EmbeddedPriceDraftImport, EmbeddedPriceImport, and StandalonePriceImport should now match the pattern ^[A-Za-z0-9_-]+$ and be 2-256 characters in length. The key value will be validated when processing import requests with the following objects:

Added Cart freeze option

14 December 2022
Composable Commerce
HTTP API
Enhancement
GraphQLCarts
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.

Announced removal of non-standard GraphQL error field

13 December 2022
Composable Commerce
HTTP API
Announcement
GraphQL
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.

Added key to Embedded Prices and Embedded PriceDrafts, and an update action to set keys for both Standalone and Embedded Prices

12 December 2022
Composable Commerce
HTTP API
Enhancement
Pricing and DiscountsGraphQL
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

Improvements to working with Business Units in the GraphQL API

7 December 2022
Composable Commerce
HTTP API
Enhancement
GraphQLCartsOrdersB2B
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!]!

Added Messages for changes on Embedded Prices and PriceMode on Products

6 December 2022
Composable Commerce
HTTP API
Enhancement
Pricing and DiscountsGraphQLMessages/Subscriptions
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:

Audit Log now tracks changes on Store's Product Selections

1 December 2022
Composable Commerce
HTTP API
Enhancement
Product catalogAudit Log
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.

Added support for expanded Channel and Customer Group to GraphQL query for StandalonePrice

1 December 2022
Composable Commerce
HTTP API
Enhancement
GraphQLPricing and Discounts
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.

Introduced Countries to Stores

10 November 2022
Composable Commerce
HTTP API
Enhancement
Project configurationMessages/SubscriptionsGraphQL
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.

Correction to the `ChangeQuoteState` type in the GraphQL API

7 November 2022
Composable Commerce
HTTP API
Resolved issue
GraphQLQuotes
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!

Introduced Attribute Groups in beta

4 November 2022
Composable Commerce
HTTP API
New feature
GraphQLProduct catalog
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.

Added functionality to automatically transition states for Quote Requests, Staged Quotes, and Quotes

24 October 2022
Composable Commerce
HTTP API
Enhancement
QuotesOrdersGraphQL
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.

Support for IAM-based authentication in the Subscriptions API

21 October 2022
Composable Commerce
HTTP API
Enhancement
GraphQLMessages/SubscriptionsExtensibility

{/* vale commercetools.Acronyms = NO */}

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.

Order import now supports Store key reference

18 October 2022
Composable Commerce
HTTP API
Enhancement
Orders
The Import Orders endpoint now supports referencing Stores by key using StoreKeyReference.

Changes:

Introduced My Quotes in beta

10 October 2022
Composable Commerce
HTTP API
New feature
Quotes
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 My 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.

Introduced Business Units in beta

6 October 2022
Composable Commerce
HTTP API
New feature
B2BCustomersProject configurationProduct catalogCartsOrdersQuotesGraphQL
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.

Announced removal of non-standard GraphQL variables format

4 October 2022
Composable Commerce
HTTP API
Announcement
Deprecation
GraphQL
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.

Added Line Item inventoryMode to the GraphQL schema

28 September 2022
Composable Commerce
HTTP API
Enhancement
CartsQuotesGraphQL
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.

Introducing the Standalone Price import endpoint

26 September 2022
Composable Commerce
HTTP API
New feature
Pricing and Discounts
The Standalone Price Import endpoint has been added to the Import API, enabling the bulk import of Standalone Price.

You can now:

  • Send us the whole StandalonePrice snapshot and we will create/update the entry in your Project by calculating the delta.

Using the Standalone Prices endpoint is the same as using other Import API endpoints. For more information:

The Product Draft endpoint only supports Embedded Prices. Standalone Prices must be imported separately using Standalone Price endpoint.

Changes:

Added 'productSelections' to Store limits query in the GraphQL API

22 September 2022
Composable Commerce
HTTP API
Enhancement
LimitsProject configurationGraphQL
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.

Added Message for changes on supply channels on Stores

16 September 2022
Composable Commerce
HTTP API
Enhancement
Project configurationMessages/SubscriptionsGraphQL
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.

Increased the limit of Line Items in Shopping Lists to 250.

16 September 2022
Composable Commerce
HTTP API
Enhancement
CartsLimits
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.

Added new state 'Delivered' to Order ShipmentState

15 September 2022
Composable Commerce
HTTP API
Enhancement
OrdersGraphQL
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.

Added 'active' field to Standalone Prices

9 September 2022
Composable Commerce
HTTP API
Enhancement
Pricing and DiscountsGraphQL
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.

Added Message for name changes on Stores

7 September 2022
Composable Commerce
HTTP API
Enhancement
Project configurationMessages/SubscriptionsGraphQL
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.

Raised limit for Stores in a Project

6 September 2022
Composable Commerce
HTTP API
Enhancement
Project configurationLimitsB2B

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.

Added support for Direct Discounts in the GraphQL API

6 September 2022
Composable Commerce
HTTP API
Enhancement
GraphQLPricing and Discounts
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.

Deprecation of PHP and .NET Core v1 SDKs

1 September 2022
Composable Commerce
HTTP API
Announcement
Deprecation
General
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.

Fixed ChangeDiscountCodeCartDiscounts type in GraphQL schema

31 August 2022
Composable Commerce
HTTP API
Resolved issue
GraphQLPricing and DiscountsProject configuration
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.

Multiple Shipping Methods for Carts and Orders

30 August 2022
Composable Commerce
HTTP API
Enhancement
CartsOrdersExtensibilityGraphQL

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.

Order import now supports Custom Fields on Line Items

26 August 2022
Composable Commerce
HTTP API
Enhancement
Orders
The Import Orders endpoint now supports Custom Fields for Line Items.

Changes:

Added Message for language changes on Stores

25 August 2022
Composable Commerce
HTTP API
Enhancement
Project configurationMessages/SubscriptionsGraphQL
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 Quote renegotiation

23 August 2022
Composable Commerce
HTTP API
Enhancement
QuotesGraphQL
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.

Customer import now supports Custom Fields on addresses

22 August 2022
Composable Commerce
HTTP API
Enhancement
Customers
The Import Customers endpoint now supports Custom Fields for Customer addresses.

Changes:

Added 'priceMode' field to CustomLineItemDraft and CustomLineItemImportDraft

17 August 2022
Composable Commerce
HTTP API
Enhancement
CartsOrdersPricing and DiscountsGraphQL

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 compatibility. You could only change the price mode on an existing Custom Line Item with the Change CustomLineItem Price Mode update action.

Added Reference Expansion for Product Search Attributes in the GraphQL API

16 August 2022
Composable Commerce
HTTP API
Enhancement
Product catalogGraphQL
Reference Expansion for Attributes of Product Projection Search 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.

Staged Standalone Prices Available in Beta

15 August 2022
Composable Commerce
HTTP API
Enhancement
Pricing and DiscountsGraphQL
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.

Added 'state' to QuoteRequest, StagedQuote, and Quote

5 August 2022
Composable Commerce
HTTP API
Enhancement
QuotesGraphQL
You can now set States reflecting custom business logic on QuoteRequests, StagedQuotes, and Quotes.

Removed closed beta features from GraphQL schema

3 August 2022
Composable Commerce
HTTP API
Resolved issue
GraphQL
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.

API Extensions now support Quote Requests, Staged Quotes and Quotes

27 July 2022
Composable Commerce
HTTP API
Enhancement
ExtensibilityQuotes
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:

Added inventory mode to Line Items

25 July 2022
Composable Commerce
HTTP API
Enhancement
CartsOrdersGraphQL
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

Added 'priceMode' to Custom Line Item

22 July 2022
Composable Commerce
HTTP API
Enhancement
CartsPricing and DiscountsGraphQL
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

PriceMode can now be set on Products using the Import API

21 July 2022
Composable Commerce
HTTP API
New feature
Pricing and DiscountsProduct catalog
You can now set the PriceMode of Products using the Product import and Product draft import endpoints.
Standalone Prices recently achieved general availability, enabling you to use Standalone Prices with the Import API. It is convenient to set the PriceMode at the Product level when creating or updating Products using the Import API.

Consult the Import API reference documentation to learn how to set the PriceMode when importing (creating or updating) a Product:

Audit Log now tracks changes on Quote Request, Staged Quotes and Quotes

18 July 2022
Composable Commerce
HTTP API
Enhancement
Audit LogQuotesGraphQL
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:

Added Message for changes on distribution channels on Stores

14 July 2022
Composable Commerce
HTTP API
Enhancement
Project configurationMessages/SubscriptionsGraphQL
You can now subscribe to Messages about additions, removals, or overwrites of product distribution Channels on Stores.

Changes:

Added existence check for Product Types

13 July 2022
Composable Commerce
HTTP API
Enhancement
Product catalogExtensibility
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.

Added OrderImport GraphQL mutation

13 July 2022
Composable Commerce
HTTP API
Enhancement
OrdersGraphQL
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.

Audit Log now tracks changes on Product Selections

12 July 2022
Composable Commerce
HTTP API
Enhancement
Audit LogProduct catalogGraphQL
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.

Introducing the Inventory import endpoint

30 June 2022
Composable Commerce
HTTP API
New feature
Product catalog
The Inventory endpoint has been added to the Import API, enabling the bulk import of Inventory Entries.

You can now:

  • Send us the whole InventoryEntry snapshot and we will create/update the entry in your Project by calculating the delta.
  • Use the Inventory endpoint to schedule hourly/daily/nightly/weekly bulk inventory import processes.

Using the Inventory endpoint is the same as using other Import API endpoints. For more information:

Changes:

Introduced Quotes in beta

30 June 2022
Composable Commerce
HTTP API
New feature
CartsOrdersPricing and DiscountsExtensibilityGraphQL
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:

Product Selections can now operate on Product Variant level

29 June 2022
Composable Commerce
HTTP API
Enhancement
Product catalogProject configurationMessages/SubscriptionsGraphQL

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:

Standalone Prices achieved general availability status

28 June 2022
Composable Commerce
HTTP API
Announcement
Pricing and DiscountsCartsProduct catalogGraphQL
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:
Read more on Standalone Prices and how to use them in the API reference.

Extended long-term support plan for Java v1 SDK

20 June 2022
Composable Commerce
HTTP API
Announcement
Deprecation
General
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 in the GraphQL schema

14 June 2022
Composable Commerce
HTTP API
Enhancement
GraphQL

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

Added update action for setting external discounts on Standalone Prices

13 June 2022
Composable Commerce
HTTP API
Enhancement
Pricing and DiscountsMessages/SubscriptionsGraphQL
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 API Extensions in Beta

8 June 2022
Composable Commerce
HTTP API
Enhancement
ExtensibilityGraphQL
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.
extend type Trigger { condition: String } extend input TriggerInput { condition: String }

Added Messages for Standalone Prices

8 June 2022
Composable Commerce
HTTP API
Enhancement
Pricing and DiscountsMessages/SubscriptionsGraphQL
You can now subscribe to Messages specific to Standalone Prices to get informed about their creation, deletion, or updates on them.

Changes:

Removed 'lastMessageSequenceNumber' from Order

24 May 2022
Composable Commerce
HTTP API
Announcement
Deprecation
OrdersGraphQL
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.

Introduced Standalone Prices in Beta

9 May 2022
Composable Commerce
HTTP API
New feature
Pricing and DiscountsCartsProduct catalogGraphQL
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 API.
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

OrderFromCartDraft Custom Fields now merge with Cart Custom Fields.

27 April 2022
Composable Commerce
HTTP API
Enhancement
OrdersExtensibility
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:

Added Cart replication to My Carts

14 April 2022
Composable Commerce
HTTP API
Enhancement
CartsOrdersGraphQL
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:

Added 'deleteAt' and 'deleteDaysAfterCreation' fields to API Clients in the GraphQL API

12 April 2022
Composable Commerce
HTTP API
Enhancement
Security and privacyGraphQL
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

Added total tax to Carts, Orders, and Line Items

8 April 2022
Composable Commerce
HTTP API
Enhancement
CartsOrdersGraphQL
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.

Added Reference Expansion for Product Attributes in the GraphQL API

4 April 2022
Composable Commerce
HTTP API
Enhancement
Product catalogGraphQL
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.

OrderFromCartDraft can now be extended with Custom Fields.

29 March 2022
Composable Commerce
HTTP API
Enhancement
OrdersExtensibilityGraphQL
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.

Audit Log now supports Stores

24 March 2022
Composable Commerce
HTTP API
Enhancement
Audit LogProject configuration
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.

Added 'paymentInfo' and 'state' fields to OrderImportDraft

23 March 2022
Composable Commerce
HTTP API
Enhancement
Orders
You can now set the PaymentInfo as well as a State to an Order via Order Import.

Changes:

Added Reference Expansion for Custom Fields in the GraphQL API

18 March 2022
Composable Commerce
HTTP API
Enhancement
GraphQL
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

Introduced AuthenticationMode for Customer

17 March 2022
Composable Commerce
HTTP API
Enhancement
CustomersGraphQL
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

Added the 'key' field to InventoryEntry

11 March 2022
Composable Commerce
HTTP API
Enhancement
GraphQLProduct catalog
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

Added 'messagePayloads' field to the 'PreviewSuccess' GraphQL type

4 March 2022
Composable Commerce
HTTP API
Enhancement
GraphQLOrders
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

Supported GraphQL schema

24 February 2022
Composable Commerce
HTTP API
Announcement
GraphQL
Please find officially released features for our GraphQL API in the schema file publicly available on Github.
Only the features listed in that schema file are fully covered by our SLAs. Any additional features you might discover through introspection are intended for selected customers taking part in closed beta programs. Since such closed beta features can change, we strongly advise against using those in productive environments.

If you are interested in evaluating a closed beta feature and you would like to provide us with feedback about it, please reach out to your contact person at commercetools.

Added sorting capability when retrieving Shipping Methods for a Location

22 February 2022
Composable Commerce
HTTP API
Enhancement
OrdersSearch
You can now sort the query results, for example by ShippingRate price, when retrieving the Shipping Methods for a Location. Before, you had to implement this logic in the store front application.

Product Selections can now be extended with Custom Fields

22 February 2022
Composable Commerce
HTTP API
Enhancement
Product catalogExtensibilityGraphQL
You can now extend the ProductSelection resource with Custom Fields. With this, you can add meta-information to your Product Selection in case it is required for your business logic.

Changes:

  • [API] Added optional custom field to ProductSelection and ProductSelectionDraft.
  • [API] Added Set Custom Type and Set CustomField update actions to Product Selections.
  • [GraphQL API] Added the following types to the GraphQL schema: SetProductSelectionCustomField, SetProductSelectionCustomType.
  • [GraphQL API] Changed the ProductSelection type:
    • Added the custom field to the ProductSelection type.
  • [GraphQL API] Changed the ProductSelectionCreatedPayload type:
    • Added the custom field to the ProductSelectionCreatedPayload type.
  • [GraphQL API] Changed the IndividualProductSelectionCreatedPayload type:
    • Added the custom field to the IndividualProductSelectionCreatedPayload type.
  • [GraphQL API] Changed the ProductSelectionUpdateAction type:
    • Input field setCustomField was added to ProductSelectionUpdateAction type
    • Input field setCustomType was added to ProductSelectionUpdateAction type
  • [GraphQL API] Changed the CreateProductSelectionDraft type:
    • Input field custom was added to CreateProductSelectionDraft type

Expiration times on access and refresh tokens can now be configured.

17 February 2022
Composable Commerce
HTTP API
Enhancement
Security and privacyGraphQL
The expiration time for access and refresh tokens can now be configured per API Client by using the new accessTokenValiditySeconds and refreshTokenValiditySeconds fields. If specified, each access and refresh token created by the API Client will expire within the specified number of seconds. If not specified, the tokens will expire as per the default configuration.

Changes:

  • [API] Added accessTokenValiditySeconds field to API Client and APIClientDraft.
  • [API] Added refreshTokenValiditySeconds field to API Client and APIClientDraft.
  • [GraphQL API] Changed the APIClientWithoutSecret type:
    • Added the refreshTokenValiditySeconds field to the APIClientWithoutSecret type.
    • Added the accessTokenValiditySeconds field to the APIClientWithoutSecret type.
  • [GraphQL API] Changed the APIClientWithSecret type:
    • Added the accessTokenValiditySeconds field to the APIClientWithSecret type.
    • Added the refreshTokenValiditySeconds field to the APIClientWithSecret type.
  • [GraphQL API] Changed the CreateApiClient type:
    • Input field refreshTokenValiditySeconds was added to CreateApiClient type
    • Input field accessTokenValiditySeconds was added to CreateApiClient type

Added field to Cart representing the total quantity of all Line Items

8 February 2022
Composable Commerce
HTTP API
Enhancement
CartsGraphQL
We added the totalLineItemQuantity field to Cart that represents the sum of all Line Item quantities. Its value does not take the Cart's Custom Line Items into consideration. With this, there is no need for you any more to calculate this value on the client side.

Changes:

  • [API] Added totalLineItemQuantity field to Cart.
  • [GraphQL API] Changed the Cart type:
    • Added the totalLineItemQuantity field to the Cart type.

Added OrderPaymentAdded Message

27 January 2022
Composable Commerce
HTTP API
Enhancement
OrdersMessages/Subscriptions
Add OrderPayment update action performed on Orders or OrderEdits now triggers Messages . To subscribe to Messages, see Subscriptions for Messages and Notifications.

Change:

Increased the limit of Customers in a Project to 10,000,000.

26 January 2022
Composable Commerce
HTTP API
Enhancement
CustomersLimits
The default limit of Customers you can have in a Project has been increased from 1 million to 10 million. This limit can be increased per Project after we reviewed the performance impact. Find more details in the documentation.

Introduced Product Selections in Beta

25 January 2022
Composable Commerce
HTTP API
New feature
Product catalogProject configurationMessages/SubscriptionsGraphQL
Product Selections let you model the availability of your products in different sales channels. Depending on your use case and by leveraging the existing Stores functionality you can create individual catalogs or assortments for your brand sites, regional shops or brick-and-mortar stores.
Currently, the feature allows you to create Product Selections, populate them with Products, add them to any of your Stores and activate them independently for each Store. We also introduced a new endpoint that returns a Product Projection available in a given Store's active Product Selections.
Please note that the focus of this first release lies in scenarios where assortment management happens in a commercetools-external product information management (PIM) system and a commercetools-external search provider is used for product discovery in the shop frontend. As a consequence, you currently can’t filter your search results by Product Selections or Stores in both, Product Projections and the Merchant Center Product list. We plan to close these gaps progressively and add more functionality to Product Selections during the public beta phase.
Read more on Product Selections and how to use them in the API reference.
Read more on how to integrate with an external search service providing product discovery for your Store-specific shop frontends in this guide.

Furthermore, you can now subscribe to Messages triggered when Product Selections are created, deleted, or updated or when the Store's Product Selections have changed.

Changes:

  • [API] Added the view_product_selections and manage_product_selections OAuth scopes.
  • [API] Added ProductSelections.
  • [API] Added query on Product Selections for a Product.
  • [API] Added Get ProductProjection in Store by ID or by Key.
  • [API] Added ProductSelectionCreated and ProductSelectionDeleted Message.
  • [API] Added ProductSelectionProductAdded and ProductSelectionProductRemoved Message.
  • [API] Added StoreProductSelectionsChanged Message.
  • [GraphQL API] Added the following types to the GraphQL schema: AddProductSelectionProduct, AddStoreProductSelection, ChangeProductSelectionName, ChangeStoreProductSelectionActive, CreateProductSelectionDraft, IndividualProductSelectionCreatedPayload, ProductAssignment, ProductAssignmentQueryResult, ProductOfSelection, ProductOfSelectionQueryResult, ProductSelection, ProductSelectionCreated, ProductSelectionCreatedPayload, ProductSelectionDeleted, ProductSelectionProductAdded, ProductSelectionProductRemoved, ProductSelectionQueryInterface, ProductSelectionQueryResult, ProductSelectionSetting, ProductSelectionSettingDraft, ProductSelectionSettingInActionInput, ProductSelectionUpdateAction, RemoveProductSelectionProduct, RemoveStoreProductSelection, SelectionOfProduct, SelectionOfProductQueryResult, SetProductSelectionKey, SetStoreProductSelections, StoreProductSelectionsChanged.
  • [GraphQL API] Changed the CreateStore type:
    • Input field productSelections was added to CreateStore type
  • [GraphQL API] Changed the Query type:
    • Added the productSelections field to the Query type.
    • Query.inStores description is changed
    • Query object type now implements ProductSelectionQueryInterface interface
    • Added the productSelectionAssignments field to the Query type.
    • Added the productSelection field to the Query type.
    • Query.inStore description is changed
  • [GraphQL API] Changed the Mutation type:
    • Added the updateProductSelection field to the Mutation type.
    • Added the deleteProductSelection field to the Mutation type.
    • Added the createProductSelection field to the Mutation type.
  • [GraphQL API] Changed the Product type:
    • Added the productSelectionRefs field to the Product type.
  • [GraphQL API] Changed the StoreCreated type:
    • Added the productSelections field to the StoreCreated type.
    • Added the productSelectionsRef field to the StoreCreated type.
  • [GraphQL API] Changed the Store type:
    • Added the productSelections field to the Store type.
  • [GraphQL API] Changed the StoreUpdateAction type:
    • Input field changeProductSelectionActive was added to StoreUpdateAction type
    • Input field setProductSelections was added to StoreUpdateAction type
    • Input field addProductSelection was added to StoreUpdateAction type
    • Input field removeProductSelection was added to StoreUpdateAction type
  • [GraphQL API] Changed the InStore type:
    • Added the product field to the InStore type.
    • Added the productSelectionAssignments field to the InStore type.

Return Items can now be extended with Custom Fields.

19 January 2022
Composable Commerce
HTTP API
Enhancement
OrdersExtensibilityGraphQL
You can now extend the LineItemReturnItem as well as the CustomLineItemReturnItem object on the Order resource with Custom Fields. With these you can, for example, add the courier name or their shipment IDs to the return items of the Orders.

Changes:

  • [API] Added custom field to LineItemReturnItem and CustomLineItemReturnItem.
  • [API] Added custom field to ReturnItemDraft.
  • [API] Added Set ReturnItem Custom Type and Set ReturnItem CustomField update actions to Orders and Order Edits.
  • [GraphQL API] Added the following types to the GraphQL schema: SetOrderReturnItemCustomField, SetOrderReturnItemCustomType SetStagedOrderReturnItemCustomField, SetStagedOrderReturnItemCustomFieldOutput, SetStagedOrderReturnItemCustomType, SetStagedOrderReturnItemCustomTypeOutput.
  • [GraphQL API] Changed the CustomLineItemReturnItem type:
    • Added the custom field to the CustomLineItemReturnItem type.
  • [GraphQL API] Changed the ReturnItem type:
    • Added the custom field to the ReturnItem type.
  • [GraphQL API] Changed the StagedOrderUpdateAction type:
    • Input field setReturnItemCustomField was added to StagedOrderUpdateAction type
    • Input field setReturnItemCustomType was added to StagedOrderUpdateAction type
  • [GraphQL API] Changed the ReturnItemDraftType type:
    • Input field custom was added to ReturnItemDraftType type
  • [GraphQL API] Changed the ReturnItemDraftTypeOutput type:
    • Added the custom field to the ReturnItemDraftTypeOutput type.
  • [GraphQL API] Changed the OrderUpdateAction type:
    • Input field setReturnItemCustomField was added to OrderUpdateAction type
    • Input field setReturnItemCustomType was added to OrderUpdateAction type
  • [GraphQL API] Changed the LineItemReturnItem type:
    • Added the custom field to the LineItemReturnItem type.

Parcels can now be extended with Custom Fields.

18 January 2022
Composable Commerce
HTTP API
Enhancement
OrdersExtensibilityGraphQL

{/* vale commercetools.Acronyms = NO */}

You can now extend the Parcel object on the Order resource with Custom Fields. With these you can, for example, add meta data associated with your ERP system to the deliveries of the Orders.

Changes:

  • [API] Added custom field to Parcel and ParcelDraft.
  • [API] Added Set Parcel Custom Type and Set Parcel CustomField update actions to Orders and Order Edits.
  • [GraphQL API] Added the following types to the GraphQL schema: SetOrderParcelCustomField, SetOrderParcelCustomType, SetStagedOrderParcelCustomField, SetStagedOrderParcelCustomFieldOutput, SetStagedOrderParcelCustomType, SetStagedOrderParcelCustomTypeOutput.
  • [GraphQL API] Changed the Parcel type:
    • Added the custom field to the Parcel type.
  • [GraphQL API] Changed the ParcelDataDraftType type:
    • Input field custom was added to ParcelDataDraftType type
  • [GraphQL API] Changed the StagedOrderUpdateAction type:
    • Input field setParcelCustomField was added to StagedOrderUpdateAction type
    • Input field setParcelCustomType was added to StagedOrderUpdateAction type
  • [GraphQL API] Changed the AddOrderParcelToDelivery type:
    • Input field custom was added to AddOrderParcelToDelivery type
  • [GraphQL API] Changed the AddStagedOrderParcelToDeliveryOutput type:
    • Added the custom field to the AddStagedOrderParcelToDeliveryOutput type.
  • [GraphQL API] Changed the ParcelData type:
    • Added the custom field to the ParcelData type.
  • [GraphQL API] Changed the AddStagedOrderParcelToDelivery type:
    • Input field custom was added to AddStagedOrderParcelToDelivery type
  • [GraphQL API] Changed the OrderUpdateAction type:
    • Input field setParcelCustomField was added to OrderUpdateAction type
    • Input field setParcelCustomType was added to OrderUpdateAction type

Added key to ProductProjection GraphQL type

14 January 2022
Composable Commerce
HTTP API
Enhancement
GraphQLSearchProduct catalog
Added key field to the ProductProjection GraphQL type.

Change:

  • [GraphQL API] Changed the ProductProjection type:
    • Added the key field to the ProductProjection type.

Added token revocation endpoint

4 January 2022
Composable Commerce
HTTP API
Enhancement
Security and privacy
You can now revoke your API access and refresh tokens compliant to Auth 2.0 Token Revocation.

Revoking tokens prevents the abuse of abandoned tokens and contributes to the security of your applications. You might want to revoke the tokens associated with the Customer, for example, when the Customer logs out, changes identity or uninstalls your application.

For more information, see Revoke tokens.

Introduced Order Search

28 December 2021
Composable Commerce
HTTP API
New feature
OrdersSearch
With the new Order Search, merchants are able to perform faster search for their orders with enhanced performance, increased query capabilities, and in a scalable way as it supports Projects with a large number of Orders. The feature needs to be activated for the Project before it can be used.
The Order Search API is utilized by our Merchant Center, but you are also welcome to build your own applications with this API. This feature is meant to support back office use cases. It is not intended for searching through the customer's order history in a storefront application.

Changes:

Added Price selection to Product Projection Search on GraphQL API

22 December 2021
Composable Commerce
HTTP API
Enhancement
GraphQLSearchProduct catalog
The Product Projection Search feature on the GraphQL API now supports price selection.

Changes:

  • [GraphQL API] Added the following types to the GraphQL schema: ScopedPrice.
  • [GraphQL API] Changed the ProductSearchVariant type:
    • Added the scopedPrice field to the ProductSearchVariant type.
    • Added the scopedPriceDiscounted field to the ProductSearchVariant type.
  • [GraphQL API] Changed the PriceSelectorInput type:
    • PriceSelectorInput.date input field type changed from DateTime! to DateTime

Core part of the Import API achieves general availability status.

21 December 2021
Composable Commerce
HTTP API
Announcement
Import ContainersMonitoring
The following features of the Import API achieved the general availability status.
Please note that all Import Request endpoints such as Products, Prices, and Categories remain in public beta until further announcement. To learn more about the Import API, please see Best practices as well as the documentation.

Deliveries can now be extended with Custom Fields

20 December 2021
Composable Commerce
HTTP API
Enhancement
GraphQLOrdersExtensibility

{/* vale commercetools.Acronyms = NO */}

You can now extend the Delivery object on the Order resource with Custom Fields. With these you can, for example, add meta data associated with your ERP system to the deliveries of the Orders.

Changes:

  • [API] Added custom field to Delivery.
  • [API] Added update actions Set Delivery Custom Type and Set Delivery CustomField to the Order.
  • [GraphQL API] Added the following types to the GraphQL schema: SetOrderDeliveryCustomField, SetOrderDeliveryCustomType, SetStagedOrderDeliveryCustomField, SetStagedOrderDeliveryCustomFieldOutput, SetStagedOrderDeliveryCustomType, SetStagedOrderDeliveryCustomTypeOutput.
  • [GraphQL API] Changed the AddOrderDelivery type:
    • Input field custom was added to AddOrderDelivery type
  • [GraphQL API] Changed the Delivery type:
    • Added the custom field to the Delivery type.
  • [GraphQL API] Changed the AddStagedOrderDelivery type:
    • Input field custom was added to AddStagedOrderDelivery type
  • [GraphQL API] Changed the StagedOrderUpdateAction type:
    • Input field setDeliveryCustomField was added to StagedOrderUpdateAction type
    • Input field setDeliveryCustomType was added to StagedOrderUpdateAction type
  • [GraphQL API] Changed the AddStagedOrderDeliveryOutput type:
    • Added the custom field to the AddStagedOrderDeliveryOutput type.
  • [GraphQL API] Changed the OrderUpdateAction type:
    • Input field setDeliveryCustomType was added to OrderUpdateAction type
    • Input field setDeliveryCustomField was added to OrderUpdateAction type

Added Product key to Line Item

16 December 2021
Composable Commerce
HTTP API
Enhancement
GraphQLCartsOrders

Previously, the Line Items in Carts and Orders contained the Product ID only, to refer to the related Product. From now on, the Line Items have the user-defined Product key also, in case it exists for the related Product. The new field is present on Carts that were created or updated after 2 December 2021 and on Orders created after this date.

Changes:

  • [API] Added productKey field to LineItem.
  • [GraphQL API] Changed the LineItem type:
    • Added the productKey field to the LineItem type.

Payment transactions can now be extended with Custom Fields

15 December 2021
Composable Commerce
HTTP API
Enhancement
GraphQLPaymentsExtensibility
You can now extend the Transaction object on the Payment resource with Custom Fields. With this, you can now store additional information, like refund details and taxed amounts, on the specific payment transaction.

Changes:

  • [API] Added custom field to Transaction, TransactionDraft, and MyTransactionDraft .
  • [API] Added update actions Set Transaction Custom Type and Set Transaction CustomField to Payments.
  • [API] Added Set Transaction CustomField update action to My Payments.
  • [GraphQL API] Added the following types to the GraphQL schema: SetPaymentTransactionCustomField, SetPaymentTransactionCustomType.
  • [GraphQL API] Changed the Transaction type:
    • Added the custom field to the Transaction type.
  • [GraphQL API] Changed the MyTransactionDraft type:
    • Input field custom was added to MyTransactionDraft type
  • [GraphQL API] Changed the TransactionDraft type:
    • Input field custom was added to TransactionDraft type
  • [GraphQL API] Changed the PaymentUpdateAction type:
    • Input field setTransactionCustomType was added to PaymentUpdateAction type
    • Input field setTransactionCustomField was added to PaymentUpdateAction type

Added update action for the supply channel of Line Items in a Cart

10 December 2021
Composable Commerce
HTTP API
Enhancement
CartsGraphQL
You can now update the inventory supply channel for Line Items that are already in a Cart. Before, you could only achieve this via replacing the existing Line Item with a new one.

Changes:

  • [API] Added Set LineItem SupplyChannel to Carts and My Carts.
  • [GraphQL API] Added the following types to the GraphQL schema: SetCartLineItemSupplyChannel.
  • [GraphQL API] Changed the CartUpdateAction type:
    • Input field setLineItemSupplyChannel was added to CartUpdateAction type
  • [GraphQL API] Changed the MyCartUpdateAction type:
    • Input field setLineItemSupplyChannel was added to MyCartUpdateAction type

Increased maximum timeout for payment-related API Extensions

9 December 2021
Composable Commerce
HTTP API
Enhancement
ExtensibilityPayments
We have increased the maximum timeout for API Extensions of resource type payment from 2 to 10 seconds what makes your integrations with payment service providers (PSPs) more reliable. You can set this timeout on the ExtensionDraft upon creation of the Extension or via Set TimeoutInMs update action (setTimeoutInMs mutation in the GraphQL API).

Added AWS EventBridge as supported Subscription destination

8 December 2021
Composable Commerce
HTTP API
Enhancement
Messages/SubscriptionsGraphQL
AWS EventBridge is now supported as a Subscription destination. Configuring EventBridge as a destination allows your serverless event bus to receive message from commercetools Composable Commerce and forward them to a variety of targets based on forwarding rules. Please find more information in our tutorial.
  • [API] Added EventBridge destination.
  • [GraphQL API] Added the following types to the GraphQL schema: EventBridgeDestination, EventBridgeDestinationInput, SetCartLineItemSupplyChannel.
  • [GraphQL API] Changed the SearchIndexingConfiguration type:
    • Added the categoriesDisabledForInternalTest field to the SearchIndexingConfiguration type.
  • [GraphQL API] Changed the CartUpdateAction type:
    • Input field setLineItemSupplyChannel was added to CartUpdateAction type
  • [GraphQL API] Changed the MyCartUpdateAction type:
    • Input field setLineItemSupplyChannel was added to MyCartUpdateAction type
  • [GraphQL API] Changed the SetStagedOrderReturnInfo type:
    • SetStagedOrderReturnInfo.items default value changed from none to []
  • [GraphQL API] Changed the DestinationInput type:
    • Input field EventBridge was added to DestinationInput type
  • [GraphQL API] Changed the ProductProjection type:
    • Removed the key field from the ProductProjection type.
  • [GraphQL API] Changed the SetOrderReturnInfo type:
    • SetOrderReturnInfo.items default value changed from none to []

Error status code 400 for POST request

7 December 2021
Composable Commerce
HTTP API
Enhancement
General
As announced on 5 November 2021, we introduced a HTTP status code 400 for errors in all Import API POST endpoints.

Added Product key to GraphQL API's Product Projection Search

3 December 2021
Composable Commerce
HTTP API
Enhancement
Product catalogGraphQLSearch
You can now add the Product key to the results of Product Projection Search queries in the GraphQL API.

Changes:

  • [GraphQL API] Added key field to the ProductProjection type.

Audit Log now tracks Custom Object Changes

2 December 2021
Composable Commerce
HTTP API
Enhancement
Audit LogExtensibilityGraphQL
We have extended the abilities of Audit Log to include the tracking of changes made against Custom Objects. This enhancement will start tracking new Custom Object Changes made and these Changes will be automatically added into your Audit Log responses.

Changes:

Added supplyChannel field to InventoryEntryQuantitySet Message

12 November 2021
Composable Commerce
HTTP API
Enhancement
Messages/SubscriptionsProduct catalogGraphQL
We added the field 'supplyChannel' to the InventoryEntryQuantitySet Message on the HTTP API and 'supplyChannel' and 'supplyChannelRef' fields to the GraphQL API. With these fields, you can check the Channel where changes took place.

Changes:

  • [API] Added the supplyChannel field to InventoryEntryQuantitySet Message.
  • [GraphQL API] Changed the InventoryEntryQuantitySet type:
    • Added the supplyChannelRef field to the InventoryEntryQuantitySet type.
    • Added the supplyChannel field to the InventoryEntryQuantitySet type.

Added CustomerFirstNameSet, CustomerLastNameSet, and CustomerTitleSet Messages

12 November 2021
Composable Commerce
HTTP API
Enhancement
Messages/SubscriptionsCustomersGraphQL
With the addition of three new Messages you can now use the MessageSubscription to subscribe to changes on the firstName, lastName, and title fields on Customers specifically. Before, you had to use the generic ChangeSubscription for that. These Messages are triggered by Set First Name, Set Last Name, and Set Title update actions.

Changes:

Added Set ReturnInfo update action and Message

10 November 2021
Composable Commerce
HTTP API
Enhancement
GraphQLOrdersMessages/Subscriptions
With the Set ReturnInfo update action, you can now delete and overwrite multiple entries in the returnInfo array field of Order in a single request. Previously, to remove an entry from the returnInfo field, it was necessary to use the Add ReturnInfo update action with a negative quantity. The Set ReturnInfo update action triggers the ReturnInfoSet Message.

Changes:

  • [API] Added Set ReturnInfo update action to Orders.
  • [API] Added Set ReturnInfo update action to Order Edits.
  • [API] Added ReturnInfoSet Message.
  • [GraphQL API] Added the following types to the GraphQL schema: ReturnInfoDraftType, ReturnInfoDraftTypeOutput, ReturnInfoSet, SetOrderReturnInfo, SetStagedOrderReturnInfo, SetStagedOrderReturnInfoOutput.
  • [GraphQL API] Changed the StagedOrderUpdateAction type:
    • Input field setReturnInfo was added to StagedOrderUpdateAction type
  • [GraphQL API] Changed the OrderUpdateAction type:
    • Input field setReturnInfo was added to OrderUpdateAction type

Error status code 400 for POST request

5 November 2021
Composable Commerce
HTTP API
Announcement
General
Effective on 7 December 2021, Import API POST endpoints will respond with the HTTP status code 400 for errors. Currently you receive the status code 200 if one or more resources in your Import Request have errors.

For the users to be able to prepare for this change, we will update the SDK before the actual change to the API takes place. The next SDK release will reflect this change. Before 7 December 2021, this new part of the SDK cannot be used.

Fixed price Cart Discounts achieved general availability status

4 November 2021
Composable Commerce
HTTP API
Announcement
CartsPricing and Discounts
After collecting feedback during the beta phase, we have moved Cart Discount type for fixed prices on Line Items out of beta. The status has been changed to general availability. With Fixed CartDiscountValue you can specify to which price you want to discount the Line Items.

Added fixed price Cart Discounts on CustomLineItems Target

4 November 2021
Composable Commerce
HTTP API
Enhancement
CartsPricing and Discounts
We have added the ability to create a fixed price Cart Discount on a CustomLineItems target.

Added support for Mark Matching Variants in GraphQL API's Product Projection Search

29 October 2021
Composable Commerce
HTTP API
Enhancement
GraphQLProduct catalog
To support the marked matching Variants feature in the GraphQL API we have added the field isMatchingVariant to the Product Variants in the result of productProjectionSearch queries. This field will only have a value when the argument markMatchingVariants (that we also added) is set to true.

Changes:

  • [GraphQL API] Changed the ProductSearchVariant type:
    • Added the isMatchingVariant field to the ProductSearchVariant type.
  • [GraphQL API] Changed the Query type:
    • Added argument markMatchingVariants to Query.productProjectionSearch field to align with the REST API.
    • Deprecated argument Query.productProjectionSearch(markMatchingVariant) in favor of markMatchingVariants.

Detailed error messages on the GraphQL API

28 October 2021
Composable Commerce
HTTP API
Enhancement
GraphQL
To assist you better in error analysis we have added an error response format to the GraphQL API. This format contains detailed information about the errors that should help you in identifying the root cause of the problem.

Unpublish Products via Import API

22 October 2021
Composable Commerce
HTTP API
Enhancement
Product catalog
You can now unpublish a Product using Product and ProductDraft import endpoints by setting the publish field to false.

Added existence check for Products

21 October 2021
Composable Commerce
HTTP API
Enhancement
Product catalog
We have added endpoints for checking whether a Product with certain ID, key or properties exists. These methods can be used if you are only interested in the existence of a certain Product without the need of fetching its product information.

Enable sorting on Custom Fields

15 October 2021
Composable Commerce
HTTP API
Enhancement
SearchExtensibility
It is now possible to sort on Custom Fields using custom.fields.${fieldName} sort parameter.

Localized name for Shipping Method

4 October 2021
Composable Commerce
HTTP API
Enhancement
OrdersGraphQL
Shipping Method now supports localized names. This enables displaying shipping methods in different languages.

Changes:

  • [API] Added localizedName to ShippingMethod.
  • [API] Added localizedName to ShippingMethodDraft.
  • [API] Added Set Localized Name Update Action.
  • [GraphQL API] Changed the ShippingMethodUpdateAction type:
    • Input field setLocalizedName was added to ShippingMethodUpdateAction type.
  • [GraphQL API] Changed the ShippingMethod type:
    • Added the localizedNameAllLocales field to the ShippingMethod type.
    • Added the localizedName field to the ShippingMethod type.
  • [GraphQL API] Changed the ShippingMethodDraft type:
    • Input field localizedName was added to ShippingMethodDraft type.
  • [GraphQL API] Added the following type to the GraphQL schema: SetShippingMethodLocalizedName.

Stores achieved general availability status

30 September 2021
Composable Commerce
HTTP API
Announcement
Project configurationLimitsExtensibility
After collecting feedback during the beta phase, we have moved Stores out of beta. The status of the following features has been changed to general availability:
In addition, to support use cases requiring a high number of Stores we have increased the limit on the number of Stores in a Project from 500 to 50000.

Added Customer Deleted Message

29 September 2021
Composable Commerce
HTTP API
Enhancement
CustomersMessages/SubscriptionsGraphQL
We have added a specific Message that is published whenever a Customer is deleted. That means, you can now subscribe to this particular message and do not need to use the generic ChangeSubscription anymore to implement such use cases.

Changes:

  • [API] Added CustomerDeleted Message.
  • [GraphQL API] Added the following types to the GraphQL schema: CustomerDeleted.

Excluding Changes initiated by background processes from Audit log results

28 September 2021
Composable Commerce
HTTP API
Enhancement
Audit LogGraphQL

It is now possible to exclude Changes initiated by background processes from Audit Log response data sets.

Change:

  • [API] Added excludePlatformInitiatedChanges query parameter to all Query Record endpoints that will allow Changes originated by background processes to be excluded from the response data set.
  • [GraphQL API] Added excludePlatformInitiatedChanges filtering parameter.

Align data type for 'date' field in PriceSelectorInput

24 September 2021
Composable Commerce
HTTP API
Enhancement
GraphQLSearch
To align usage of data types on the GraphQL API we changed the type of the date field on PriceSelectorInput to DateTime.

Changes:

  • [GraphQL API] Changed the PriceSelectorInput.date type from Instant! to DateTime!

Added exists operator to GraphQL API

23 September 2021
Composable Commerce
HTTP API
Enhancement
GraphQL
To improve the developer experience for you we have added an exists operator to our GraphQL API. This improvement to the API design is now the recommended way of checking the existence of query results because
  1. it optimizes the query resulting in shorter response times and
  2. it avoids you finding workarounds with other query fields to achieve the same.

Changes:

  • [GraphQL API] Added the Boolean exists field to all QueryResult types.

Custom Objects in Custom Fields and Attributes is now supported.

17 September 2021
Composable Commerce
HTTP API
Enhancement
ExtensibilityProduct catalog
Reference Type Custom Fields of type key-value-document are now supported. This enables you to import Custom Objects in Custom Fields. Custom Fields of this type can be imported for every resource that supports Custom Fields. Attributes (of ProductVariant) of key-value-document Reference Type are also supported. Please see CustomObjectKeyReference for more information.

New Processing State structure introduced

7 September 2021
Composable Commerce
HTTP API
Enhancement
General
As announced on 9 August 2021, we introduced a new Processing State structure. Additionally, the Processing State values are now spelled in the (lower) camel case to better align with the HTTP API.
The processing of your Import Request itself should not be impacted by this change; however, if you have some sort of monitoring using Processing States, you need to change the code. We apologize for the inconvenience this may cause.

The following changes were made:

  • Introduced a new Processing State processing. This is the initial state assigned to an Import Operation.
  • The unresolved state will no longer be the initial state.
  • The unresolved state continues to be used (but exclusively) as the state to indicate missing references.
  • key of ProductVariantDraftImport is now mandatory.

Added Correlation ID to calls to external OAuth server

1 September 2021
Composable Commerce
HTTP API
Enhancement
Security and privacy
Calls to the introspection endpoint of an external OAuth server now include the correlation ID initially passed in the request. This enables users to have a complete trace of the HTTP calls exchanged with the API and thus helps troubleshoot implementation issues.

Announced long-term support plan for Composable Commerce SDKs

31 August 2021
Composable Commerce
HTTP API
Announcement
Deprecation
General

We have set up a long-term support plan to actively support and maintain Version 1 (v1) SDKs until their end of life. Additionally, we have provided information about migration to our Version 2 (v2) SDKs that are constantly updated with the newest API features as soon as they are released. This support plan indicates when you could schedule the migration to v2 SDKs.

Renaming Import Sink to Import Container and restructuring URLs.

30 August 2021
Composable Commerce
HTTP API
Enhancement
Deprecation
Import ContainersProduct catalog
The Import Sink is deprecated and replaced with the Import Container. This deprecation is for the name change purpose, and all functionalities and behaviors of the Import Sink are succeeded by the Import Container without change. The name change, however, is accompanied by the restructuring of the URL patterns toward the REST standard. The changed URLs are listed below. The old deprecated URLs and the Import Sink endpoint stay available until 30 November 2021. They will be removed thereafter. We encourage the switch to the Import Container and the new URLs.

The following changes were made:

  • Import Sink is deprecated and Import Container was introduced. This is a name change. All functionalities and behaviors of the Import Sink is succeeded by the Import Container.
  • key is now mandatory in ProductVariantDraftImport.
  • Resource import POST request (for example, Import Categories and Import ProductTypes)
    • previous: /{projectKey}/{resourceType}/importSinkKey={importSinkKey}
    • current: /{projectKey}/{resourceType}/importContainerKey/{importContainerKey}
  • Monitoring endpoints
    • Get ImportSummary
      • previous: /{projectKey}/import-summaries/importSinkKey={importSinkKey}
      • current: /{projectKey}/import-containers/{importContainerKey}/import-summaries
    • Get ImportOperation by ID
      • previous: /{projectKey}/{resourceType}/importSinkKey={importSinkKey}/import-operations/{id}
      • current: /{projectKey}/import-operations/{id}
    • Query ImportOperations by Import Container ID
      • previous: /{projectKey}/{resourceType}/importSinkKey={importSinkKey}/import-operations
      • current: /{projectKey}/import-containers/{importContainerKey}/import-operations

Introduced limits on Store's Inventory Supply and Product Distribution Channels

20 August 2021
Composable Commerce
HTTP API
Announcement
LimitsProject configurationGraphQLProduct catalog
To ensure best performance for your queries we have now limited the Channel settings for Stores. From now on each of your Stores can have
  • up to 100 Inventory Supply Channels and
  • up to 100 Product Distribution Channels

by default.

These default limits can be increased if needed after we have reviewed the performance impact on your project. To request a limit increase, please contact the Composable Commerce support team, specifying your project region, project key and your use case.

Increased the limit of subscriptions to 50

19 August 2021
Composable Commerce
HTTP API
Enhancement
Messages/SubscriptionsLimits
The limit of Subscriptions per Project has been raised from 25 to 50.

Added Product Projection Search to GraphQL API

18 August 2021
Composable Commerce
HTTP API
Enhancement
GraphQLSearchProduct catalog
Product Projection Search can now be performed using the GraphQL API.

Changes:

  • [GraphQL API] Added the following types to the GraphQL schema: CategoryOrderHintProductSearch, DimensionsProductSearch, DiscountedProductSearchPriceValue, ExistsFilterInput, FacetResult, FacetResultValue, ImageProductSearch, MissingFacetInput, MissingFilterInput, PriceSelectorInput, ProductPriceSearch, ProductProjection, ProductProjectionSearchResult, ProductSearchPriceTier, ProductSearchVariant, ProductSearchVariantAvailabilitiesResult, ProductSearchVariantAvailability, ProductSearchVariantAvailabilityWithChannel, ProductSearchVariantAvailabilityWithChannels, RangeCount, RangeCountDouble, RangeCountLong, RangeElementInput, RangeFacetInput, RangeFacetResult, RangeFilterInput, RawProductSearchAttribute, SearchFacetInput, SearchFacetModelInput, SearchFilterInput, SearchFilterModelInput, SearchKeywordProductSearch, SearchKeywordsProductSearch, SuggestTokenizerProductSearch,CustomSuggestTokenizerProductSearch,WhitespaceSuggestTokenizerProductSearch, TermCount, TermsFacetInput, TermsFacetResult, TreeFacetInput, TreeFilterInput, ValueCountFacetInput, ValueFacetInput, ValueFacetResult, ValueFilterInput.
  • [GraphQL API] Changed the Query type:
    • Added the productProjectionSearch field to the Query type.

Introducing a new Processing State structure

9 August 2021
Composable Commerce
HTTP API
Announcement
General
Effective from 6 September 2021, we will introduce a new Processing State. The new Processing State called Processing will be added as a default state. The Unresolved state will be reserved exclusively for unresolved references.
This will be a breaking change from the business logic perspective although we are only changing the meaning of an existing state without removing it. The processing of your import request itself should not be impacted by this change; however, if you have some sort of monitoring using Processing States, you will need to change the code. We apologize for the possible inconvenience.
Currently, the Unresolved state has the following meaning:
On 6 September 2021, we will introduce a new state called Processing and the following changes will take place:
  • Processing will be the new default Processing State assigned to Import Operations when they are created.
  • The Unresolved state will no longer be the initial state.
  • The Unresolved state continues to be used (but exclusively) as the state to indicate missing references. A user's action will be required in this state to fix the missing references.

Added Store Created and Store Deleted Messages

5 August 2021
Composable Commerce
HTTP API
Enhancement
GraphQLProject configurationMessages/Subscriptions

You can now subscribe to messages triggered when Stores are created and deleted.

Changes:

  • [API] Added StoreCreated Message
  • [API] Added StoreDeleted Message
  • [GraphQL API] Added the following types to the GraphQL schema: StoreCreated, and StoreDeleted.

Introduced a limit on Product Types

30 July 2021
Composable Commerce
HTTP API
Enhancement
Product catalogLimits
Introduced a limit on Product Types. For Projects created after 23 June 2021, the number of Product Types in a Project is limited to 1 000. To request a limit increase, please contact the Composable Commerce support team.

Unresolved references can now be discovered with debug mode

23 July 2021
Composable Commerce
HTTP API
Enhancement
Monitoring
We have introduced a debug mode for the Query Import Operation endpoints for all resource types. This mode makes it easier for you to find out what the reason is for the Import Operation being in the Unresolved Processing State by listing which references exactly could not be resolved.
When setting the debug query parameter to true you will find the list of unresolved references in the respective additional field in the query response as shown in the following example.

ImportSink is no longer specific to a ResourceType

6 July 2021
Composable Commerce
HTTP API
Enhancement

Since an ImportSink is no longer specific to an ImportResourceType it is no longer mandatory to specify the ImportResourceType when creating an ImportSink.

The following change was made:

  • Made the resourceType field on the ImportSinkDraft optional.

Total field added to ImportOperationPagedResponse

5 July 2021
Composable Commerce
HTTP API
Enhancement
Monitoring
Pagination through the query results for Import Operations is now fully supported by populating the total number of results in the paged query response.

The following change was made:

Staged field was added to ProductVariantPatch

28 June 2021
Composable Commerce
HTTP API
Enhancement
Product catalogPatches
Added the staged field to ProductVariantPatch. The field can be used to specify whether to apply ProductVariant updates to the current projection of a Product.

The following change was made:

Added sort query parameter for ImportSinks

23 June 2021
Composable Commerce
HTTP API
Enhancement
The query endpoint for ImportSinks now supports the sort parameter.

The following changes were made:

  • Added sort query parameter to the query ImportSinks endpoint.
  • The query parameters limit and offset are now optional at the query ImportSinks endpoint.

Introducing Order Patch endpoint

7 June 2021
Composable Commerce
HTTP API
New feature
Orders
Introduced Order Patch endpoint. It should be used to update ReturnInfo, Parcel, and Delivery of an existing Order. The updates can be many in a single request or as one update per request.

The following endpoint was added:

Extending Audit Log tracked Changes

19 May 2021
Composable Commerce
HTTP API
Enhancement
Audit LogOrdersGraphQL
Extended support for Audit Log Change tracking. The following Changes are now properly identified and displayed in the Change History API instead of being identified as an UnknownChange. This applies to both the REST and the GraphQL APIs.

Key as the identifier of Address at Customer Import endpoint

11 May 2021
Composable Commerce
HTTP API
Enhancement
Customers
The Customer Import endpoint is enabled again. We have made the changes below. You will receive proper 2XX responses for valid API requests. We apologize for the inconvenience we may have caused.
The Customers Import endpoint now uses key of an Address as a mandatory identifier for Addresses, and id is no longer a supported identifier. Said differently, the addresses field in CustomerImport now takes the CustomerAddress type, replacing the previous Address.

The following changes were made:

Customer Import endpoint is temporarily under maintenance

27 April 2021
Composable Commerce
HTTP API
Announcement
Customers
The Customers Import endpoint of the Import API is currently under maintenance.
You currently receive a 503 Service Unavailable error if you try to access the Customers Import endpoint. We are working on a fix to bring this endpoint back to work and we will inform you in a further release note again as soon as the fix is deployed. We apologize for any inconvenience this may cause.

Added restrictions on unsupported fields in payloads

27 April 2021
Composable Commerce
HTTP API
Enhancement
Every endpoint of the Import API now accepts only supported fields in input payloads. Any Import API POST request with an unsupported field input will fail with an InvalidFieldError.

Key field is removed from OrderImport

23 April 2021
Composable Commerce
HTTP API
Enhancement
Deprecation
Orders
The key field is deprecated from OrderImport of the Import API. The existing field orderNumber is now a required identifier for any Order import or update. The following changes were made at the Order Import endpoint:
  • Deprecated the key field in OrderImport.
  • The existing (previously optional) field orderNumber is now required.

Add Store to Shopping List

23 April 2021
Composable Commerce
HTTP API
Enhancement
CartsProject configurationGraphQL
You can now set a Store on Shopping Lists, and view and manage Shopping Lists and My Shopping Lists in a Store. When expanding the Line Items on a Shopping List in a Store, the prices, locales, and inventory are filtered to only include data for the specified Store.

Automatic deactivation of indexing of Product information for non-production Projects

7 April 2021
Composable Commerce
HTTP API
Announcement
Search
Indexing of Product information for non-production Projects will automatically be deactivated if there have been no calls against the following API endpoints within the last 30 days:

The deactivation of Product information indexing will always happen on the day after a 30 day observation period.

The first deactivations will happen on 12 April 2021 and will include Projects that had no calls against the aforementioned API endpoints between 13 March 2021 and 11 April 2021. Please see the example below:

  • Start date 30 days observation period: 13 March 2021
  • End date 30 days observation period: 11 April 2021
  • Last API call or day of activation (search indexing activated): 12 March 2021
  • Day of automatic deactivation: 12 April 2021
Deactivation of Product information indexing means that calls to either of the above Product Projection Search or Product Suggestions endpoint will return a status code of 400 unless Product information indexing is explicitly re-activated. Please refer to API documentation for more details.
At the moment, this change does not apply to Projects that are marked as production Projects or any Projects hosted on AWS Hosts.

Enhanced configuration for indexing Product information

22 March 2021
Composable Commerce
HTTP API
Enhancement
ExtensibilityGraphQLSearch
By adding Client Logging information to the Search Indexing Configuration you can now find out who changed this project configuration and when it was changed.
  • [API] Added lastModifiedBy and lastModifiedAt fields to SearchIndexingConfigurationValues
  • [GraphQL API] Changed the SearchIndexingConfigurationValues type:
    • Added the lastModifiedBy field to the SearchIndexingConfigurationValues type.
    • Added the lastModifiedAt field to the SearchIndexingConfigurationValues type.

Introduced Audit Log

15 March 2021
Composable Commerce
HTTP API
New feature
Audit Log
Introduced Audit Log, a new feature that tracks and stores changes made against resources in your Project. You can now view a historical log of these changes via the Change History API, including GraphQL, or the Merchant Center. The feature is currently available in our Google Cloud Regions.

Removed deprecated functionality from GraphQL API

5 March 2021
Composable Commerce
HTTP API
Announcement
Deprecation
GraphQL
As announced before, we have now removed deprecated fields and OAuth scopes from the GraphQL API. Using those fields in your GraphQL API requests will yield to HTTP 400 errors with header X-DEPRECATION-NOTICE from now on.

Added configuration for indexing of product information

26 February 2021
Composable Commerce
HTTP API
Enhancement
ExtensibilitySearchGraphQL
Indexing of product information for the Product Projection Search and the Product Suggestions endpoints is now configurable via the Project endpoint. Using these endpoints is only possible if indexing has been activated for the Project and the search index has been built. Otherwise, the API replies with a 400 Bad Request error to requests on these endpoints.

Changed default settings for new Projects

26 February 2021
Composable Commerce
HTTP API
Announcement
Search
For Projects created after 3 March 2021, indexing of product information for the Product Projection Search and the Product Suggestions endpoints will be deactivated per default. To activate the indexing of Product information for your new Project, please choose one of the following options:
Activation via the Merchant Center will be possible soon.

Reference Customer Groups by key

3 February 2021
Composable Commerce
HTTP API
Enhancement
Product catalogPricing and Discounts
You can now reference a Customer Group using a user-defined field key in addition to id when Creating a Product, Setting a Product's Price, or Adding or Changing Embedded Prices of a Product Variant.

Use External User ID from an external OAuth token in Client Logging

2 February 2021
Composable Commerce
HTTP API
Enhancement
Security and privacy
With this enhancement, you can now use external OAuth to set the External User ID for the lastModifiedBy and createdBy fields. Previously, this was only possible by specifying the X-External-User-ID header, which did not work well with the External OAuth flows.

Introduced fixed price cart discounts as beta feature

1 February 2021
Composable Commerce
HTTP API
Enhancement
Pricing and DiscountsGraphQLCarts
Introduced a new Cart Discount type for fixed prices on line items. With this you can now specify to which price you want to discount the line items, so far you could define the amount or percentage to be deducted from the line item price only.
With this new discount type, you can model cart promotions like these:
  1. Final Sale - all articles of the 'Sales' category in the cart for 15€ each
  2. Buy a pair of sunglasses for 10€ with coupon code SUNGLASSES (not limited to one pair, all pairs will become 10€)
  3. Phone accessories are only $10 with the purchase of any new phone (not limited to one accessory, all accessories will become $10)
  4. Get any 2 shirts for $50 each (not limited to two shirts, all shirts will become $50 if there are at least 2 shirts in the cart).

Custom Fields for Addresses

29 January 2021
Composable Commerce
HTTP API
Enhancement
ExtensibilityCartsOrdersCustomersPricing and Discounts
We now provide Custom Fields on Address. This enables users to customize Addresses for their needs. When fetching Addresses, the user can filter them by Custom fields.

Added GraphQL support for Replicate Cart in Store endpoint

28 January 2021
Composable Commerce
HTTP API
Enhancement
GraphQLProject configurationCartsOrders
You can now replicate any Cart or Order in a given Store to a new Cart bound to the same Store using the GraphQL API.

Added Custom Fields to Shipping Methods

27 January 2021
Composable Commerce
HTTP API
Enhancement
ExtensibilityGraphQLOrders
You can now add Custom Fields to Shipping Methods via the Shipping Methods API and the GraphQL API endpoints. This allows you to provide more information about your shipping services, for instance, the estimated delivery window, a carrier code, a pick-up point, or the 'track and trace URL format'.

Added variant.key to predicate field identifiers

25 January 2021
Composable Commerce
HTTP API
Enhancement
Pricing and Discounts
It is now possible to use variant.key as a Discount Predicate field identifier. This allows you to use the same Discount Predicate for your production environment as you have used on your staging environment. Before it was not always possible since you had to rely on the automatically generated product.id and variant.id instead that differ between Projects.

Added a reference to anonymous cart on customer

12 January 2021
Composable Commerce
HTTP API
Enhancement
Deprecation
CustomersCarts
It is now possible to identify an anonymous cart by using its id or external key. The previously used anonymousCartId will soon be deprecated.

Added Customer Password Updated Message

6 January 2021
Composable Commerce
HTTP API
Enhancement
Messages/SubscriptionsCustomers

You can now subscribe to messages triggered when Customers have changed their password.

Added Replicate Cart in Store endpoint

5 January 2021
Composable Commerce
HTTP API
Enhancement
Project configurationCartsOrders
Merchants may now replicate any Cart or Order in a given Store to a new Cart bound to the same Store.

Fixed validation on Products POST endpoint

22 December 2020
Composable Commerce
HTTP API
Resolved issue
Product catalog
The Products POST endpoint now only accepts fields that are valid according to the ProductImport representation. Before, you could find errors only in the ImportOperation and ImportSummary in case of invalid fields on ProductImports.

Added key to Cart

22 December 2020
Composable Commerce
HTTP API
Enhancement
Deprecation
CartsOrders
Additionally to identifying Carts by their id, it is now possible to use key as a user-defined identifier for the list of operations below. This gives you more flexibility when referencing Carts from commercetools-external systems.

Added sort query parameter in GET endpoints

18 December 2020
Composable Commerce
HTTP API
Enhancement
General
In all Get ImportOperations by an ImportSink Key endpoints, we now support an additional query parameter sort, with which you can sort the createdAt and lastModifiedAt fields with sort options asc (default) or desc. Multiple sorting is also allowed for up to three fields.
Sorting in the Import API works the same way as in the commercetools Composable Commerce HTTP APIs. Please refer to our existing documentation for the commercetools Composable Commerce API for more details.

Added endpoints for Product Variant Patches

18 December 2020
Composable Commerce
HTTP API
New feature
Product catalogPatches

Now you are able to update more than one ProductVariants belonging to different or the same Products with several small Patches.

Allow subscriptions to Customer Token events

14 December 2020
Composable Commerce
HTTP API
Enhancement
Messages/SubscriptionsCustomers
You can now subscribe to changes on CustomerToken via a Change Subscription. This allows you to track if and how often the Customers in your Project change their passwords.

Added 'oldSlug' field to CategorySlugChanged and ProductSlugChanged Messages

14 December 2020
Composable Commerce
HTTP API
Enhancement
Messages/SubscriptionsGraphQLProduct catalog
We added the new field oldSlug to the CategorySlugChanged Message and ProductSlugChanged Message that contains the slug as it was before the change. This information makes it easier for you to track changes of your slugs and to implement auto-redirection strategies for those product and category pages that have moved temporarily or permanently. On the GraphQL API you can now also query for the oldSlugAllLocales field of the messages in the fragments CategorySlugChanged and ProductSlugChanged.
  • [API] Added optional field oldSlug to CategorySlugChanged Message.
  • [API] Added optional field oldSlug to ProductSlugChanged Message.
  • [GraphQL API] Added the oldSlug and oldSlugAllLocales fields to CategorySlugChanged type of messages query.
  • [GraphQL API] Added the oldSlug and oldSlugAllLocales fields to ProductSlugChanged type to messages query.

Added Product Suggestions GraphQL Query Schema

7 December 2020
Composable Commerce
HTTP API
Enhancement
GraphQLProduct catalogPricing and Discounts
Product suggestions can now be queried using the GraphQL API. Product discounts can now be retrieved by key, using the GraphQL API.
  • [GraphQL API] Added the following types to the GraphQL schema: SearchKeywordArgument, SuggestResult, SuggestResultEntry, Suggestion.
  • [GraphQL API] Changed the Query type:
    • Added the productProjectionsSuggest field to the Query type.
    • Argument key was added to Query.productDiscount field
    • Query.productDiscount(id) type changed from String! to String

Added key field to PriceDraftImport

12 November 2020
Composable Commerce
HTTP API
Enhancement
Introduced support to the key field in EmbeddedPriceDraftImport as an optional input.
It is now possible to keep track of the EmbeddedPriceDraftImports that are sent in ProductDraftImportRequests.

Introduced a character limit for the full-text search query parameter on product projection search

11 November 2020
Composable Commerce
HTTP API
Enhancement
SearchLimits
To ensure the best performance for your queries, product projection search results are based on the first 256 characters of the full-text search query parameter only. This change applies for projects created after 09 November 2020. Everything beyond 256 characters will be ignored. You can continue to pass longer query parameters, the API call will still be successful.

New error codes for operations on a Store

9 November 2020
Composable Commerce
HTTP API
Enhancement
Project configuration
Two error codes were added for operations on a Store. The ProjectNotConfiguredForLanguages error code is returned for the attempt to create a Store with languages that are not supported by the Store's project. The same error code is also returned if an attempt to add or set non-project languages on a Store is made. The MissingRoleOnChannel error code is returned for the attempt to create a Store with a supplyChannel or distributionChannel referencing a Channel that misses the respective ChannelRole. The same error code is also returned if the user attempts to add or set a supplyChannel or distributionChannel referencing a Channel without the required ChannelRole.

GraphQL out of beta | End of life for deprecated fields

2 November 2020
Composable Commerce
HTTP API
Announcement
Deprecation
GraphQL
We are moving the commercetools Composable Commerce GraphQL API out of beta on 31 January 2021.

During the beta phase, we gathered insights about operational complexity and usage and decided to make a few changes.

  • Deprecated fields will be removed from the GraphQL API.
  • Deprecated OAuth scopes will be removed from the GraphQL API. The deprecated scopes are often too broad to allow for meaningful access right restrictions.
Check the list of deprecated fields for suggestions what to use instead.

Total prices for giftLineItems in cart predicates

29 October 2020
Composable Commerce
HTTP API
Enhancement
Pricing and Discounts
Cart Predicate Functions like lineItemTotal, lineItemNetTotal and lineItemGrossTotal now take the discounted price of a giftLineItem into account. This solves the issue of a giltLineItem remaining in a Cart after a cart update even if the predicate does not apply anymore.

DataErasure parameter added to ResourceDeleted Subscription Notification

26 October 2020
Composable Commerce
HTTP API
Enhancement
Messages/Subscriptions
When a resource is deleted with the dataErasure parameter set to true on the DELETE request, the ResourceDeletedDeliveryPayload will also contain the dataErasure parameter. This allows downstream systems to erase the data as well.

Added Messages GraphQL Query Schema

21 October 2020
Composable Commerce
HTTP API
Enhancement
GraphQLMessages/Subscriptions
Messages can now be queried using the GraphQL API.
  • [GraphQL API] Added the following types to the GraphQL schema: CategoryCreated, CategorySlugChanged, CustomLineItemStateTransition, CustomerAddressAdded, CustomerAddressChanged, CustomerAddressRemoved, CustomerCompanyNameSet, CustomerCreated, CustomerDateOfBirthSet, CustomerEmailChanged, CustomerEmailVerified, CustomerGroupSet, CustomerPasswordUpdated, DeliveryAdded, DeliveryAddressSet, DeliveryItemsUpdated, DeliveryRemoved, DummyLocalizedString, InventoryEntryCreated, InventoryEntryCreatedContent, InventoryEntryDeleted, InventoryEntryQuantitySet, LineItemStateTransition, Message, MessageId, MessagePayload, MessageQueryResult, OrderBillingAddressSet, OrderCreated, OrderCustomLineItemAdded, OrderCustomLineItemDiscountSet, OrderCustomLineItemQuantityChanged, OrderCustomLineItemRemoved, OrderCustomerEmailSet, OrderCustomerGroupSet, OrderCustomerSet, OrderDeleted, OrderDiscountCodeAdded, OrderDiscountCodeRemoved, OrderDiscountCodeStateSet, OrderEditApplied, OrderImported, OrderLineItemAdded, OrderLineItemDiscountSet, OrderLineItemDistributionChannelSet, OrderLineItemRemoved, OrderPaymentStateChanged, OrderReturnShipmentStateChanged, OrderShipmentStateChanged, OrderShippingAddressSet, OrderShippingInfoSet, OrderShippingRateInputSet, OrderStateChanged, OrderStateTransition, OrderStoreSet, ParcelAddedToDelivery, ParcelItemsUpdated, ParcelMeasurementsUpdated, ParcelRemovedFromDelivery, ParcelTrackingDataUpdated, PaymentCreated, PaymentInteractionAdded, PaymentStatusInterfaceCodeSet, PaymentStatusStateTransition, PaymentTransactionAdded, PaymentTransactionStateChanged, ProductAddedToCategory, ProductCreated, ProductDeleted, ProductImageAdded, ProductPriceDiscountUpdateMessagePayload, ProductPriceDiscountsSet, ProductPriceExternalDiscountSet, ProductProjectionMessagePayload, ProductPublished, ProductRemovedFromCategory, ProductRevertedStagedChanges, ProductSlugChanged, ProductStateTransition, ProductUnpublished, ProductVariantAdded, ProductVariantDeleted, ReferenceId, ReturnInfoAdded, ReviewCreated, ReviewRatingSet, ReviewStateTransition, UserProvidedIdentifiers.
  • [GraphQL API] Changed the Query type:
    • Added the message field to the Query type.
    • Added the messages field to the Query type.

OAuth scopes for Custom Objects

14 October 2020
Composable Commerce
HTTP API
Enhancement
Security and privacyExtensibility
Added new OAuth scopes for Custom Objects. This way you no longer need to grant scopes for Products on API clients if the clients should have access to this endpoint only.
  • [API] Added scope manage_key_value_documents:{projectKey} which grants access to all the APIs for creating, modifying, deleting and viewing Custom Objects.
  • [API] Added scope view_key_value_documents:{projectKey} which grants access to the APIs for viewing Custom Objects.

Custom Objects are supported in Subscriptions and are now limited

14 October 2020
Composable Commerce
HTTP API
Enhancement
ExtensibilityLimits
You can now subscribe to Custom Objects via a Change Subscription.
For Projects created after 07 October 2020, a maximum of 20000000 Custom Objects can be created.
  • [API] Subscriptions can now deliver notifications for Custom Objects.
  • [API] Introduced an API Limit on Custom Objects.

The total of PagedQueryResult is limited to the maximum offset

12 October 2020
Composable Commerce
HTTP API
Enhancement
LimitsExtensibility
To ensure the best performance for your queries, the total field of PagedQueryResult is now limited to the maximum offset of 10000 when the results are filtered with a Query Predicate. This limit is not in place when no query predicate is applied.
Calculation of the total field should be deactivated whenever possible by using the query parameter withTotal=false. Please refer to the pagination section of the "General Concepts" documentation for details and recommendations.

Changes in the GraphQL schema

8 October 2020
Composable Commerce
HTTP API
Enhancement
GraphQLProject configurationExtensibility
You can now add Custom Fields to Stores.
  • [GraphQL API] Changed the Store type:
    • Added the custom field to the Store type.

Filtering for Store Order Imports

6 October 2020
Composable Commerce
HTTP API
Enhancement
Project configurationOrders

When Orders are imported to a Store, the languages, Prices, and InventoryEntries of the Orders are now filtered according to the Store settings. Also, the distribution and supply channels of the Store are matched against those of LineItems and CustomLineItems during import of the Orders.

Added the QueryTimedOut error code

6 October 2020
Composable Commerce
HTTP API
Enhancement
When a query times out, the API now returns BadRequest with the QueryTimedOut error code instead of the General error code.

Added endpoints for Order and Customer imports

1 October 2020
Composable Commerce
HTTP API
New feature
OrdersCustomers
The Import API now supports two additional resource types, Orders and Customers.
To create or update Orders in bulk, use the Importing Orders endpoint. This new feature calls Order API endpoints such as Create an Order by Import for creating new orders and Update Order for updating existing orders.
To create or update Customers in bulk, use Importing Customers endpoint. This new feature calls Customer API endpoints such as Create Customer for creating Customers and Update Customer for updating existing Customers.

The new feature includes the following changes.

Orders import:

  • New endpoint for Order import Request Order data to be imported.
  • New endpoint for querying the status of Order ImportOperations by an ImportSink key Get ImportOperations by an ImportSink key.
  • New endpoint for querying the status of Order ImportOperations by its id Get Import operation by its ID.

Customers import:

  • New endpoint for Customer import Request customer data to be imported.
  • New endpoint for querying the status of Customer ImportOperations by an ImportSink key Get ImportOperations by an ImportSink Key.
  • New endpoint for querying the status of Customer ImportOperation by its id Get ImportOperation by its ID.

Product Variant Added Message

25 September 2020
Composable Commerce
HTTP API
Enhancement
Messages/SubscriptionsProduct catalog

When a product variant is created, a message will be triggered.

Correlation ID with cross-origin resource sharing

23 September 2020
Composable Commerce
HTTP API
Enhancement
Security and privacy
The Correlation ID is now a part of the Access-Control-Allow-Headers, which allows you to include X-Correlation-ID header in browser apps, impacted by cross-origin resource sharing restrictions. Additional information can be found in this tutorial.

Query Custom Objects in a container

16 September 2020
Composable Commerce
HTTP API
Enhancement
Deprecation
Extensibility
Custom Objects within a container can now be queried without an extra where parameter for it. Doing it this way improves the query performance and hence the previous way with the parameter has been deprecated. Since Custom Objects are now primarily identified by their container and key, access to and deletion of them by their id has been deprecated also.

This feature includes the following changes:

  • [API] Added the /{projectKey}/custom-objects/{container}/ endpoint to Query CustomObjects
  • [API] Deprecated the /{projectKey}/custom-objects/ endpoint from Query CustomObjects
  • [API] Deprecated the GET and the DELETE /{projectKey}/custom-objects/{id} endpoints.

Adds lastModifiedAt to LineItem

7 September 2020
Composable Commerce
HTTP API
Enhancement
CartsOrdersGraphQL
A new field is introduced to LineItems of Carts, Orders and OrderEdits. This field is updated whenever one of setLineItemShippingDetails, addLineItem, removeLineItem, or changeLineItemQuantity changes the LineItem.
  • [API] Added a lastModifiedAt field to LineItem
  • [GraphQL API] Changed the LineItem type:
    • Added the lastModifiedAt field to the LineItem type.

Added Custom Fields to Stores

7 September 2020
Composable Commerce
HTTP API
Enhancement
ExtensibilityProject configurationGraphQL
You can now define custom fields on Stores.

This feature includes the following changes:

Introduced the following changes to the GraphQL schema (in SDL format):

extend type Store { custom: CustomFieldsType } extend input StoreUpdateAction { setCustomType: SetCustomType setCustomFields: SetCustomFields }

Public beta release of Import API

3 September 2020
Composable Commerce
HTTP API
New feature

Recently we introduced Import API to allow you to import your large amount of data into commercetools Composable Commerce using an API-first approach.

While the previous solutions for data importing still being relevant, we launch the import API as a beta solution and intend to understand your data import use cases. Import API is in public beta but it supports almost all the major resource types such as Product, Category, Product Type, Variants, and Prices.

You can try new import API using Postman collection or you can use our latest SDKs to implement solutions programmatically.
postman-collection-link

Updates to the GraphQL schema

28 August 2020
Composable Commerce
HTTP API
Enhancement
GraphQLExtensibility
Custom objects can now be created, updated, and deleted using the GraphQL API.
  • [GraphQL API] Added the following types to the GraphQL schema: CustomObject, CustomObjectDraft, CustomObjectQueryResult.
  • [GraphQL API] Changed the Query type:
    • Added the customObject field to the Query type.
    • Added the customObjects field to the Query type.
  • [GraphQL API] Changed the Mutation type:
    • Added the createOrUpdateCustomObject field to the Mutation type.
    • Added the deleteCustomObject field to the Mutation type.

New deprecated fields on GraphQL

27 August 2020
Composable Commerce
HTTP API
Enhancement
Deprecation
GraphQLCartsExtensibilityProduct catalogSecurity and privacy

Deprecated additional fields on the GraphQL API and added new fields that should be used instead.

  • [GraphQL API] Changed the LineItemDraftOutput type:
    • Field supplyChannel was deprecated in LineItemDraftOutput type.
    • Field distributionChannel was deprecated in LineItemDraftOutput type.
    • Added the distributionChannelResId field to the LineItemDraftOutput type.
    • Added the supplyChannelResId field to the LineItemDraftOutput type.
  • [GraphQL API] Changed the CustomLineItemDraftOutput type:
    • Field taxCategory was deprecated in CustomLineItemDraftOutput type
    • Added the taxCategoryResId field to the CustomLineItemDraftOutput type.
  • [GraphQL API] Changed the Initiator type:
    • Field customer was deprecated in Initiator type.
    • Field user was deprecated in Initiator type.
    • Added the customerRef field to the Initiator type.
    • Added the userRef field to the Initiator type.
  • [GraphQL API] Changed the NestedAttributeDefinitionType type:
    • Field typeReference was deprecated in NestedAttributeDefinitionType type
    • Added the typeRef field to the NestedAttributeDefinitionType type.
  • [GraphQL API] Changed the CustomFieldsCommand type:
    • Field type was deprecated in CustomFieldsCommand type
    • Added the typeResId field to the CustomFieldsCommand type.

Added setDistributionChannel action for Carts and OrderEdits

25 August 2020
Composable Commerce
HTTP API
Enhancement
CartsOrders
You can now use a new action setLineItemDistributionChannel on OrderEdit, Cart and My Cart to change the Distribution Channel.
  • [API] Added the SetLineItemDistributionChannel action for order edits
  • [API] Added the SetLineItemDistributionChannel action for carts
  • [API] Added the SetLineItemDistributionChannel action for my carts
  • [GraphQL API] Added the following types to the GraphQL schema: SetCartLineItemDistributionChannel, SetStagedOrderLineItemDistributionChannel, SetStagedOrderLineItemDistributionChannelOutput.
  • [GraphQL API] Changed the CartUpdateAction type:
    • Input field setLineItemDistributionChannel was added to CartUpdateAction type
  • [GraphQL API] Changed the StagedOrderUpdateAction type:
    • Input field setLineItemDistributionChannel was added to StagedOrderUpdateAction type
  • [GraphQL API] Changed the MyCartUpdateAction type:
    • Input field setLineItemDistributionChannel was added to MyCartUpdateAction type

Added ReferencedResourceNotFound error type

24 August 2020
Composable Commerce
HTTP API
Enhancement
General

In case of bad request due to a referenced resource not found, the new error code identifies this error and provides extra information about the resource not found.

Added addedAt field to Cart's LineItems

24 August 2020
Composable Commerce
HTTP API
Enhancement
CartsOrders
LineItems of the Cart and My Cart now have a field addedAt, which contains the DateTime when the LineItem was added to the Cart. addedAt can be passed in through the API, and if omitted, it is created on the Server with the current DateTime as default.
  • [API] Added addedAt to LineItem
  • [API] Added addedAt to LineItemDraft
  • [API] Added addedAt to MyLineItemDraft
  • [API] Added addedAt to Add LineItem action My Carts action
  • [API] Added addedAt to LineItemDraft for Add LineItem on the Order Edits action
  • [GraphQL API] Changed the AddStagedOrderLineItem type:
    • Input field addedAt was added to AddStagedOrderLineItem type
  • [GraphQL API] Changed the LineItemDraft type:
    • Input field addedAt was added to LineItemDraft type
  • [GraphQL API] Changed the AddCartLineItem type:
    • Input field addedAt was added to AddCartLineItem type
  • [GraphQL API] Changed the LineItem type:
    • Added the addedAt field to the LineItem type.
  • [GraphQL API] Changed the LineItemDraftOutput type:
    • Added the addedAt field to the LineItemDraftOutput type.
  • [GraphQL API] Changed the AddMyCartLineItem type:
    • Input field addedAt was added to AddMyCartLineItem type
  • [GraphQL API] Changed the MyLineItemDraft type:
    • Input field addedAt was added to MyLineItemDraft type

Added Store based inventory filtering

17 August 2020
Composable Commerce
HTTP API
Enhancement
Project configurationProduct catalog
You can now add Inventory Supply Channels to Stores. When querying ProductProjections, you can then use the query parameter storeProjection to remove all inventory entries from the response payload that don't correspond to the Inventory Supply Channels set in the Store.
Setting Inventory Supply Channels on Stores also affects cart line items. If a cart is bound to a store and the store has Inventory Supply Channels set, then only inventory entries from these channels (and inventory entries not linked to any channel) are included in the product variant information of the line item. Additionally, the supplyChannel field on a line item can only be set to one of the inventory supply channels set in the store.

To enable the configuration of inventory supply channels in Stores, the following changes have been made:

  • [API] Added supplyChannels field to StoreDraft
  • [API] Added supplyChannels field to Store
  • [API] Added setSupplyChannels update action to Store
  • [API] Added addSupplyChannel update action to Store
  • [API] Added removeSupplyChannel update action to Store
  • [GraphQL API] Added the following types to the GraphQL schema: SetStoreSupplyChannels, AddStoreSupplyChannel, RemoveStoreSupplyChannel.
  • [GraphQL API] Changed the StoreUpdateAction type:
    • Input field setSupplyChannels was added to StoreUpdateAction type
    • Input field addSupplyChannel was added to StoreUpdateAction type
    • Input field removeSupplyChannel was added to StoreUpdateAction type
  • [GraphQL API] Changed the CreateStore type:
    • Input field supplyChannels was added to CreateStore type
  • [GraphQL API] Changed the Store type:
    • Added the supplyChannels field to the Store type.
    • Added the supplyChannelsRef field to the Store type.

GraphQL API to query project-specific limits

23 July 2020
Composable Commerce
HTTP API
Enhancement
GraphQLLimits

You can now check limits that are specific to a project with a GraphQL query.

Which limits are included?

  • Limits that can be changed
  • Limits that only apply to projects created after the introduction of the respective limit.
  • If the total count of resources stored is limited, you can also access the current count

{/* */}

  • [GraphQL API] Added the following types to the GraphQL schema: CartDiscountLimitsProjection, CartLimitsProjection, CustomerGroupLimitsProjection, CustomerLimitsProjection, ExtensionLimitsProjection, Limit, LimitWithCurrent, OrderEditLimitsProjection, ProductDiscountLimitsProjection, ProductLimitsProjection, ProjectCustomLimitsProjection, QueryLimitsProjection, RefreshTokenLimitsProjection, ShippingMethodLimitsProjection, ShoppingListLimitsProjection, StoreLimitsProjection, TaxCategoryLimitsProjection, ZoneLimitsProjection.
  • [GraphQL API] Changed the Query type:
    • Added the limits field to the Query type.

Added OrderEdit GraphQL query and mutation schema

21 July 2020
Composable Commerce
HTTP API
Enhancement
GraphQLOrders

Order edits can now be queried, created, updated, and deleted using the GraphQL API.

Added QueryComplexityLimitExceeded Error Code to the GraphQL API

21 July 2020
Composable Commerce
HTTP API
Enhancement
GraphQL
Enhanced an error code for complex GraphQL queries to be more specific. The error code occurs when the GraphQL query is too complex to be executed.
  • [GraphQL API] Added the QueryComplexityLimitExceeded error code.

Added Store based price filtering

14 July 2020
Composable Commerce
HTTP API
Enhancement
Pricing and DiscountsProduct catalogProject configuration
You can now add Product Distribution Channels to Stores. When querying ProductProjections, you can then use the query parameter storeProjection to remove all prices from the response payload that don't correspond to the Channels set in the Store.
Setting Product Distribution Channels on Stores also affects cart line items. If a cart is bound to a store and the store has Product Distribution Channels set, then only prices from these channels (and prices not linked not any channel) are included in the product variant information of the line item. Additionally, the distributionChannel field on the cart used for the Line Item price selection can only be set to one of the channels set in the store.

To enable the configuration of product distribution channels in Stores, the following changes have been made:

  • [API] Added distributionChannels field to StoreDraft
  • [API] Added distributionChannels field to Store
  • [API] Added setDistributionChannels update action to Store
  • [API] Added addDistributionChannel update action to Store
  • [API] Added removeDistributionChannel update action to Store
  • [GraphQL API] Added the following types to the GraphQL schema: SetStoreDistributionChannels
  • [GraphQL API] Changed the StoreUpdateAction type:
    • Input field setDistributionChannels was added to StoreUpdateAction type
    • Input field addDistributionChannel was added to StoreUpdateAction type
    • Input field removeDistributionChannel was added to StoreUpdateAction type
  • [GraphQL API] Changed the CreateStore type:
    • Input field distributionChannels was added to CreateStore type
  • [GraphQL API] Changed the Store type:
    • Added the distributionChannelsRef field to the Store type.
    • Added the distributionChannels field to the Store type.

Added OrderEdit GraphQL query and mutation schema

10 July 2020
Composable Commerce
HTTP API
Enhancement
OrdersGraphQL

Order edits can now be queried, created, updated, and deleted using the GraphQL API.

Introduced Limits on Zones, Tax Categories, Shipping Methods, Customer Groups, Customers, Shopping Lists and Order Edits

8 July 2020
Composable Commerce
HTTP API
Announcement
LimitsPricing and DiscountsCustomersCartsOrders
Introduced new limits for new projects on commercetools Composable Commerce.

The new limits and their defaults are:

  • Zones per project: 100
  • Tax Categories per project: 100
  • Shipping Methods per project: 100
  • Customer Groups per project: 1000
  • Customers per project: 1000000
  • Shopping Lists per project: 10000000
  • Carts per project: 10000000
  • Order Edits per project: 100000

Projects created before 08 July 2020 are not subject to the new limits listed above.

For newer projects, all of the limits listed above can be increased if needed after we have reviewed the performance impact on your project. To request a limit increase, please contact the Composable Commerce support team, specifying your project region, project key, and your use case.

External total prices for line items in cart predicates

1 July 2020
Composable Commerce
HTTP API
Enhancement
Pricing and Discounts
Cart Predicate Functions like lineItemTotal are now taking the total prices for line items into account also when ExternalTotal LineItemPriceMode is used.

Refresh tokens expiration

1 July 2020
Composable Commerce
HTTP API
Announcement
Security and privacy
The number of refresh tokens is now limited to 10 million. Please refer to our documentation on creating anonymous sessions only once necessary. If the limit is exceeded, the least recently used refresh tokens are deleted. Creating new refresh tokens continues to work. Therefore a refresh token that is frequently used will never expire.
This limit can be increased per project after we review the performance impact. Please contact the Composable Commerce support team and provide the region, project key and use case.

If your production project currently exceeds this limit, you will be contacted by us.

Specific error code for deleting language from project settings.

29 June 2020
Composable Commerce
HTTP API
Enhancement
Extensibility
We added the specific error code for attempts to delete languages from a Project that are still in use by at least one Store.
  • [API] Added the LanguageUsedInStores error code.

Project setting to use country tax rate fallback

24 June 2020
Composable Commerce
HTTP API
Enhancement
CartsPricing and Discounts
Carts contain mismatched line item tax rates if no tax rate from the tax category rate list matches the country-state combination of the current shipping address. By using the countryTaxRateFallbackEnabled setting, the cart will fallback to the country-no state tax rate inside each tax category.
The countryTaxRateFallbackEnabled cart setting can be configured globally at project level.

Get, update, and delete My Shopping Lists by key

16 June 2020
Composable Commerce
HTTP API
Enhancement
Carts
We now support getting, updating, and deleting My Shopping Lists by key.

Added GraphQL mutations for Payments and MyPayments

29 May 2020
Composable Commerce
HTTP API
Enhancement
GraphQLPayments
Payments and MyPayments can now be created, updated, and deleted using the GraphQL API.
  • [GraphQL API] Added the following types to the GraphQL schema: AddMyPaymentTransaction, AddPaymentInterfaceInteraction, AddPaymentTransaction, ChangePaymentAmountPlanned, ChangePaymentTransactionInteractionId, ChangePaymentTransactionState, ChangePaymentTransactionTimestamp, MyPayment, MyPaymentDraft, MyPaymentQueryResult, MyPaymentUpdateAction, MyTransactionDraft, PaymentDraft, PaymentMethodInfoInput, PaymentStatusInput, PaymentUpdateAction, SetPaymentAmountPaid, SetPaymentAmountRefunded, SetPaymentAnonymousId, SetPaymentAuthorization, SetPaymentCustomField, SetPaymentCustomType, SetPaymentCustomer, SetPaymentExternalId, SetPaymentInterfaceId, SetPaymentKey, SetPaymentMethodInfoInterface, SetPaymentMethodInfoMethod, SetPaymentMethodInfoName, SetPaymentStatusInterfaceCode, SetPaymentStatusInterfaceText, SetStoreSupplyChannels, TransactionDraft, TransitionPaymentState.
  • [GraphQL API] Changed the Me type:
    • Added the payments field to the Me type.
    • Added the payment field to the Me type.
  • [GraphQL API] Changed the StoreUpdateAction type:
    • Input field setSupplyChannels was added to StoreUpdateAction type
  • [GraphQL API] Changed the CreateStore type:
    • Input field supplyChannels was added to CreateStore type
  • [GraphQL API] Changed the Mutation type:
    • Added the createPayment field to the Mutation type.
    • Added the createMyPayment field to the Mutation type.
    • Added the updatePayment field to the Mutation type.
    • Added the updateMyPayment field to the Mutation type.
    • Added the deletePayment field to the Mutation type.
    • Added the deleteMyPayment field to the Mutation type.

Added Extension GraphQL query and mutation schema

21 April 2020
Composable Commerce
HTTP API
Enhancement
ExtensibilityGraphQL

Extensions can now be queried, created, updated, and deleted using the GraphQL API.

  • [GraphQL API] Added the following types to the GraphQL schema: AWSLambdaDestination, AWSLambdaDestinationInput, ActionType, AuthorizationHeader, AuthorizationHeaderInput, AzureFunctionsAuthentication, AzureFunctionsAuthenticationInput, ChangeExtensionDestination, ChangeExtensionTriggers, Extension, ExtensionDestination, ExtensionDestinationInput, ExtensionDraft, ExtensionQueryResult, ExtensionUpdateAction, HttpDestination, HttpDestinationAuthentication, HttpDestinationAuthenticationInput, HttpDestinationInput, SetExtensionKey, SetExtensionTimeoutInMs, Trigger, TriggerInput.
  • [GraphQL API] Changed the Query type:
    • Added the extensions field to the Query type.
    • Added the extension field to the Query type.
  • [GraphQL API] Changed the Mutation type:
    • Added the deleteExtension field to the Mutation type.
    • Added the updateExtension field to the Mutation type.
    • Added the createExtension field to the Mutation type.

Input Variables in Query Predicates

9 April 2020
Composable Commerce
HTTP API
Enhancement
Search
API endpoints that support query predicates now allow passing input variables as separate HTTP query parameters to simplify working with query strings that contain dynamic values.

Customer address by key selection for updates

9 April 2020
Composable Commerce
HTTP API
Enhancement
Customers

The address selection for updating customer addresses is now easier. In addition to select an address by its address ID it is now possible to select it by key.

Added Subscription GraphQL query and mutation schema

8 April 2020
Composable Commerce
HTTP API
Enhancement
GraphQLMessages/Subscriptions

Subscriptions can now be queried, created, updated, and deleted using the GraphQL API.

  • [GraphQL API] Added the following types to the GraphQL schema: AzureServiceBusDestination, AzureServiceBusDestinationInput, ChangeSubscription, ChangeSubscriptionDestination, ChangeSubscriptionInput, CloudEventsSubscriptionsFormat, CloudEventsSubscriptionsFormatInput, Destination, DestinationInput, EventGridDestination, EventGridDestinationInput, GoogleCloudPubSubDestination, GoogleCloudPubSubDestinationInput, MessageSubscription, MessageSubscriptionInput, NotificationFormat, PlatformFormat, PlatformFormatInput, SNSDestination, SNSDestinationInput, SQSDestination, SQSDestinationInput, SetSubscriptionChanges, SetSubscriptionKey, SetSubscriptionMessages, Subscription, SubscriptionDraft, SubscriptionFormatInput, SubscriptionHealthStatus, SubscriptionQueryResult, SubscriptionUpdateAction.
  • [GraphQL API] Changed the Query type:
    • Added the subscription field to the Query type.
    • Added the subscriptions field to the Query type.
  • [GraphQL API] Changed the Mutation type:
    • Added the updateSubscription field to the Mutation type.
    • Added the deleteSubscription field to the Mutation type.
    • Added the createSubscription field to the Mutation type.

OAuth scopes for categories

7 April 2020
Composable Commerce
HTTP API
Enhancement
Security and privacy
Added new OAuth scopes for Categories. This way you are no longer required to grant scopes for Products on API clients that are supposed to have access to these endpoints only.
  • [API] Added scope manage_categories:{projectKey} which grants access to all the APIs for creating, deleting and viewing Categories
  • [API] Added scope view_categories:{projectKey} which grants access to the APIs for viewing Categories

commercetools Composable Commerce on Google Cloud Sydney

2 April 2020
Composable Commerce
HTTP API
Enhancement
General
commercetools Composable Commerce is now available in Australia on Google Cloud Sydney in addition to our existing Regions in North America and Europe. Find the URLs to the commercetools Composable Commerce API here. Log in here.

Inventory Entry Created Message

24 March 2020
Composable Commerce
HTTP API
Enhancement
Messages/SubscriptionsProduct catalog

When an inventory is added to a product variant, an inventory entry created message will be triggered, making possible to respond to changes in availability information.

Changed endpoints to get the matching shipping methods for a location and an order edit

24 March 2020
Composable Commerce
HTTP API
Enhancement
Deprecation
Orders

To streamline the API design, the endpoint to get matching shipping methods for a location and an order edit have been changed. For backwards compatibility the previous format is still in operation, but has now been deprecated.

OAuth scopes for cart discounts, customer groups, tax categories and shipping methods

16 March 2020
Composable Commerce
HTTP API
Enhancement
CartsOrdersPricing and DiscountsSecurity and privacy
We added new OAuth scopes for Cart Discounts, Customer Groups, Tax Categories and Shipping Methods. This way you are no longer required to grant scopes for Orders or Customers on API clients that are supposed to have access to these endpoints only.
  • [API] Added scope manage_cart_discounts:{projectKey} which grants access to all the APIs for creating, deleting and viewing Cart Discounts
  • [API] Added scope view_cart_discounts:{projectKey} which grants access to the APIs for viewing Cart Discounts
  • [API] Added scope manage_customer_groups:{projectKey} which grants access to all the APIs for creating, deleting and viewing Customer Groups
  • [API] Added scope view_customer_groups:{projectKey} which grants access to the APIs for viewing Customer Groups
  • [API] Added scope manage_tax_categories:{projectKey} which grants access to all the APIs for creating, deleting and viewing Tax Categories
  • [API] Added scope view_tax_categories:{projectKey} which grants access to the APIs for viewing Tax Categories
  • [API] Added scope manage_shipping_methods:{projectKey} which grants access to all the APIs for creating, deleting and viewing Shipping Methods
  • [API] Added scope view_shipping_methods:{projectKey} which grants access to the APIs for viewing Shipping Methods

Smaller product payloads projected on locales

12 March 2020
Composable Commerce
HTTP API
Enhancement
CartsProduct catalogSearchProject configuration
When querying Product Projections the response payload contains all existing translations of localized fields. To remove unneeded translations and reduce the payload you can now use one of two new query parameters: storeProjection and localeProjection. In both cases the returned projections only contain values in the specified locales.
When using Stores, you can add languages to a given store and use storeProjection to fetch the list of locales automatically from that store. Another benefit of this approach is that line items of carts bound to the store are projected accordingly.
If you don't use stores you can use localeProjection to specify the needed locales directly in the query.

Added Review GraphQL query and mutation schema

9 March 2020
Composable Commerce
HTTP API
Enhancement
GraphQLProduct catalogSearch

Reviews can now be queried, created, updated, and deleted using the GraphQL API.

  • [GraphQL API] Added the following types to the GraphQL schema: Review, ReviewQueryResult, ReviewTarget, ReviewDraft, ReviewUpdateAction, SetReviewAuthorName, SetReviewCustomField, SetReviewCustomType, SetReviewCustomer, SetReviewKey, SetReviewLocale, SetReviewRating, SetReviewTarget, SetReviewText, SetReviewTitle, TargetReferenceInput, TransitionReviewState.
  • [GraphQL API] Changed the Channel type:
    • Channel object type now implements ReviewTarget interface
  • [GraphQL API] Changed the Product type:
    • Product object type now implements ReviewTarget interface
  • [GraphQL API] Changed the Query type:
    • Added the reviews field to the Query type.
    • Added the review field to the Query type.
  • [GraphQL API] Changed the Mutation type:
    • Added the updateReview field to the Mutation type.
    • Added the deleteReview field to the Mutation type.
    • Added the createReview field to the Mutation type.

Setting the store on existing orders

4 March 2020
Composable Commerce
HTTP API
Enhancement
OrdersProject configuration
A new update action has been introduced to set the Store an order is assigned to. It should be used to migrate existing orders to a newly introduced store. Therefore no validations are performed (such as that the customer is allowed to create orders in the store).

Add localized description field for shipping method

3 March 2020
Composable Commerce
HTTP API
Enhancement
CartsOrders

To be able to describe a shipping method in different languages, the following changes have been made:

Access States Using Key

19 February 2020
Composable Commerce
HTTP API
Enhancement
Extensibility

You can now get, update, and delete a State using its key. This eases the implementation of configuration-as-code patterns where creation and updating of a project's configuration is automated using version controlled code.

States GraphQL Mutations

17 February 2020
Composable Commerce
HTTP API
Enhancement
ExtensibilityGraphQL

States can now be modified using the GraphQL API.

  • [GraphQL API] Added the following types to the GraphQL schema: StateDraft, StateUpdateAction, AddStateRoles, ChangeStateInitial, ChangeStateKey, ChangeStateType, SetStateDescription, SetStateName, SetStateRoles, SetStateTransitions, RemoveStateRoles.
  • [GraphQL API] Changed the Mutation type:
    • Added the createState field to the Mutation type.
    • Added the updateState field to the Mutation type.
    • Added the deleteState field to the Mutation type.

Types GraphQL mutations

17 February 2020
Composable Commerce
HTTP API
Enhancement
ExtensibilityGraphQL
Types can now be created, updated, and deleted via GraphQL API also.
  • [GraphQL API] Added the following types to the GraphQL schema: AddTypeEnumValue, AddTypeFieldDefinition, AddTypeLocalizedEnumValue, ChangeTypeEnumValueLabel, ChangeTypeEnumValueOrder, ChangeTypeFieldDefinitionOrder, ChangeTypeInputHint, ChangeTypeKey, ChangeTypeLabel, ChangeTypeLocalizedEnumValueLabel, ChangeTypeLocalizedEnumValueOrder, ChangeTypeName, EnumValueInput, FieldDefinitionInput, FieldTypeEnumTypeDraft, FieldTypeInput, FieldTypeLocalizedEnumTypeDraft, FieldTypeReferenceTypeDraft, FieldTypeSetTypeDraft, RemoveTypeFieldDefinition, SetTypeDescription, SimpleFieldTypeDraft, TypeDefinitionDraft, TypeUpdateAction.
  • [GraphQL API] Changed the Mutation type:
    • Added the updateTypeDefinition field to the Mutation type.
    • Added the createTypeDefinition field to the Mutation type.
    • Added the deleteTypeDefinition field to the Mutation type.

Changed endpoints to get the matching shipping methods for a cart by cart id

6 February 2020
Composable Commerce
HTTP API
Enhancement
Deprecation
Carts

To streamline the API design, the endpoint to get matching shipping methods for a cart by cart ID has been changed. For backwards compatibility the previous format is still in operation, but has now been deprecated.

commercetools Composable Commerce on AWS, new API host names

3 February 2020
Composable Commerce
HTTP API
Announcement
Security and privacy

commercetools Composable Commerce is now available on AWS in addition to the existing Regions which are operated on the Google Cloud Platform. All self sign-up accounts continue to be created in Google Cloud Regions.

To increase region and cloud provider transparency, a new host naming scheme has been introduced for the API. Existing API host names will continue to be available as aliases for backwards compatibility.
Merchant Center and ImpEx will receive new host URLs later in a separate step. Merchant Center users will then automatically be forwarded to the new URLs.
Although the deprecated hostnames like api.sphere.io (Google Cloud, Belgium), api.commercetools.com (Google Cloud, Belgium) and api.commercetools.co (Google Cloud, Iowa) and their respective counterparts for the auth hosts remain intact as aliases, we strongly encourage changing your configuration to the new host name structure.

Further Changes:

  • [Documentation] Integrated ImpEx documentation content into the general "Developer Center" documentation section

Changed endpoints to get cart by customer id

27 January 2020
Composable Commerce
HTTP API
Enhancement
Deprecation
Customers

To streamline the API design, the endpoint to get a cart by customer ID has been changed. For this, the customer ID is now specified as segment of the URI path and no longer as query parameter. For backwards compatibility the previous format is still in operation, but has now been deprecated.

Updates to the GraphQL references

17 January 2020
Composable Commerce
HTTP API
Enhancement
CartsGraphQLPricing and Discounts
We have made some changes on the GraphQL API that affect referenced resources in product prices, discounts, discount codes, inventory entries and shipping infos.
The reference fields on those resources now support querying for the data stored in referenced objects, similar to Reference Expansion on the HTTP API. The plain reference can now be queried with the corresponding <fieldName>Ref field that has been introduced on the mentioned resources. If you, for example for performance reasons, want to continue using the plain references, you should amend your queries to use the corresponding <fieldName>Ref field instead of the <fieldName> field.
For backward compatibility reasons, the typeId field is still available on the <fieldName> queries, but it is now deprecated. It will be removed from the API after April 2020.
  • [GraphQL API] Changed the ProductDiscount type:
    • Added the referenceRefs field to the ProductDiscount type.
  • [GraphQL API] Changed the ProductPrice type:
    • ProductPrice.channel field type changed from Reference to Channel
    • ProductPrice.customerGroup field type changed from Reference to CustomerGroup
    • Added the customerGroupRef field to the ProductPrice type.
    • Added the channelRef field to the ProductPrice type.
  • [GraphQL API] Changed the ShippingInfo type:
    • Added the taxCategoryRef field to the ShippingInfo type.
    • ShippingInfo.taxCategory field type changed from Reference to TaxCategory
  • [GraphQL API] Changed the CartDiscount type:
    • Added the referenceRefs field to the CartDiscount type.
  • [GraphQL API] Changed the InventoryEntry type:
    • InventoryEntry.supplyChannel field type changed from Reference to Channel
    • Added the supplyChannelRef field to the InventoryEntry type.
  • [GraphQL API] Changed the DiscountCode type:
    • Added the referenceRefs field to the DiscountCode type.

Project setting to automatically delete carts and shopping lists

8 January 2020
Composable Commerce
HTTP API
Enhancement
CartsExtensibility
Instead of setting the deleteDaysAfterLastModification on each cart or shopping list individually, it can now be configured globally at project level. The carts and shopping lists are automatically deleted after they haven't been modified for the specified amount of days.
deleteDaysAfterLastModification can still be set when creating or updating a cart or shopping list, which also overwrites the default value.

For new projects created after this release, the project configuration is set to delete carts after 90 days, and shopping lists after 360 days.

Add Channel GraphQL mutations

3 January 2020
Composable Commerce
HTTP API
Enhancement
GraphQL
  • [GraphQL API] Changed the Mutation type:
    • Added the createChannel field to the Mutation type.
    • Added the updateChannel field to the Mutation type.
    • Added the deleteChannel field to the Mutation type.
  • [GraphQL API] Added the following types to the GraphQL schema: ChannelDraft, GeometryInput, ChannelUpdateAction, SetChannelRoles, AddChannelRoles, RemoveChannelRoles, ChangeChannelDescription, ChangeChannelKey, ChangeChannelName, SetChannelAddress, SetChannelCustomField, SetChannelCustomType, SetChannelGeoLocation.

Subscriptions support CloudEvents version 1.0

23 December 2019
Composable Commerce
HTTP API
Enhancement
Messages/Subscriptions

{/* vale commercetools.DiscriminatoryWords = NO */}

We've released support for CloudEvents version 1.0. CloudEvents is a specification for describing event data in a common way. CloudEvents seeks to ease event declaration and delivery across services, platforms, and beyond. It is hosted by the Cloud Native Computing Foundation.
As of now, the version 0.1 is deprecated and will not be supported after March 2020. Please update or replace your existing CloudEvent Subscriptions. The documentation around 0.1 has been removed.
The 1.0 version of the spec has had several major changes, including renaming and lowercasing of all attributes, as well as the introduction of the subject field. We have removed all of the proprietary extensions and support two documented extension attributes: dataref and sequence/sequencetype. The data field payload is now one of the known payloads (that means either a Message Payload, a ResourceCreated Payload, a ResourceUpdated Payload, or a ResourceDeleted Payload).

Added GraphQL support for ReviewRatingStatistics

17 December 2019
Composable Commerce
HTTP API
Enhancement
GraphQLProduct catalog
It is now possible to retrieve ReviewRatingStatistics on Products and Channels via GraphQL API.
  • [GraphQL API] Added the following types to the GraphQL schema: ReviewRatingStatistics.
  • [GraphQL API] Changed the Channel type:
    • Added the reviewRatingStatistics field to the Channel type.
  • [GraphQL API] Changed the Product type:
    • Added the reviewRatingStatistics field to the Product type.

OAuth scopes for discount codes

17 December 2019
Composable Commerce
HTTP API
Enhancement
Pricing and DiscountsSecurity and privacy
We added new OAuth scopes for managing or viewing Discount Codes. This way you are no longer required to grant scopes for viewing or managing Orders on API clients that are supposed to manage discount codes only.
  • [API] Added scope manage_discount_codes:{projectKey} which grants access to all the APIs for creating, updating, deleting and viewing discount codes.
  • [API] Added scope view_discount_codes:{projectKey} which grants access to the APIs for retrieving and querying discount codes.

Shipping methods for a cart with store-based OAuth permissions

13 December 2019
Composable Commerce
HTTP API
Enhancement
CartsGraphQLOrdersSecurity and privacy
Shipping methods for a cart can now be retrieved using store-based OAuth permissions such as view_orders:{projectKey}:{storeKey}. The functionality itself is unchanged.

ShoppingLists GraphQL mutations

19 November 2019
Composable Commerce
HTTP API
Enhancement
CartsGraphQL
  • [GraphQL API] Added the following types to the GraphQL schema: AddShoppingListLineItem, AddShoppingListTextLineItem, ChangeShoppingListLineItemQuantity, ChangeShoppingListLineItemsOrder, ChangeShoppingListName, ChangeShoppingListTextLineItemName, ChangeShoppingListTextLineItemQuantity, ChangeShoppingListTextLineItemsOrder, MyShoppingListDraft, MyShoppingListUpdateAction, RemoveShoppingListLineItem, RemoveShoppingListTextLineItem, SetShoppingListAnonymousId, SetShoppingListCustomField, SetShoppingListCustomType, SetShoppingListCustomer, SetShoppingListDeleteDaysAfterLastModification, SetShoppingListDescription, SetShoppingListKey, SetShoppingListLineItemCustomField, SetShoppingListLineItemCustomType, SetShoppingListSlug, SetShoppingListTextLineItemCustomField, SetShoppingListTextLineItemCustomType, SetShoppingListTextLineItemDescription, ShoppingListDraft, ShoppingListLineItemDraft, ShoppingListUpdateAction, TextLineItemDraft.
  • [GraphQL API] Changed the Mutation type:
    • Added the updateMyShoppingList field to the Mutation type.
    • Added the createShoppingList field to the Mutation type.
    • Added the deleteShoppingList field to the Mutation type.
    • Added the createMyShoppingList field to the Mutation type.
    • Added the updateShoppingList field to the Mutation type.
    • Added the deleteMyShoppingList field to the Mutation type.

Retrieve ShoppingLists via GraphQL

1 November 2019
Composable Commerce
HTTP API
Enhancement
CartsGraphQL
You can now query for ShoppingLists and My Shopping Lists on the GraphQL API.
  • [GraphQL API] Added the following types to the GraphQL schema: ShoppingList, ShoppingListLineItem, ShoppingListQueryInterface, ShoppingListQueryResult, TextLineItem.
  • [GraphQL API] Changed the Me type:
    • Added the shoppingList field to the Me type.
    • Added the shoppingLists field to the Me type.
  • [GraphQL API] Changed the InStoreMe type:
    • Added the shoppingList field to the InStoreMe type.
    • Added the shoppingLists field to the InStoreMe type.
  • [GraphQL API] Changed the Query type:
    • Added the shoppingList field to the Query type.
    • Query object type now implements ShoppingListQueryInterface interface
    • Added the shoppingLists field to the Query type.
  • [GraphQL API] Changed the MeQueryInterface type:
    • Added the shoppingLists field to the MeQueryInterface type.
    • Added the shoppingList field to the MeQueryInterface type.

My profile for Stores in Beta

25 October 2019
Composable Commerce
HTTP API
Enhancement
CustomersGraphQLSecurity and privacyProject configuration
Introduced methods to the HTTP API and GraphQL API that allow you to access a customer profile that is assigned to a store with an OAuth token generated with the password flow. The APIs can be used with the new OAuth scope manage_my_profile:acme-inc:luxury-brand.
  • [API] Added the following methods the HTTP API to access My Customer Profile in a specific Store:
  • [GraphQL API] Changed the Me type:
    • Me object type now implements ActiveCartInterface interface
    • Me object type now implements OrderQueryInterface interface
    • Me object type now implements CartQueryInterface interface
  • [GraphQL API] Changed the CustomerSignMeUpDraft type:
    • Input field stores was added to CustomerSignMeUpDraft type
  • [GraphQL API] Changed the InStoreMe type:
    • InStoreMe object type now implements CartQueryInterface interface
    • Added the customer field to the InStoreMe type.
    • InStoreMe object type now implements OrderQueryInterface interface
    • InStoreMe object type now implements ActiveCartInterface interface
  • [GraphQL API] Changed the Mutation type:
    • Argument storeKey was added to Mutation.customerConfirmMyEmail field
    • Argument storeKey was added to Mutation.updateMyCustomer field
    • Argument storeKey was added to Mutation.customerChangeMyPassword field
    • Argument storeKey was added to Mutation.customerResetMyPassword field
    • Argument storeKey was added to Mutation.customerSignMeUp field
    • Argument storeKey was added to Mutation.deleteMyCustomer field
    • Argument storeKey was added to Mutation.customerSignMeIn field
  • [API] New store-based OAuth scopes manage_my_profile:{projectKey}:{storeKey}.

Added `geoLocation` field to the `Channel` GraphQL type

8 October 2019
Composable Commerce
HTTP API
Enhancement
GraphQL
  • [GraphQL API] Added the following types to the GraphQL schema: Geometry, Point.
  • [GraphQL API] Changed the Channel type:
    • Added the geoLocation field to the Channel type.

Publishing the Postman collection

19 September 2019
Composable Commerce
HTTP API
Enhancement
General
Our Postman collection can be loaded into your postman application and contains a complete library of templates for the possible requests to the API endpoints.

It is autogenerated from the API reference and continuously updated in the GitHub repository.

Store in Order Import

17 September 2019
Composable Commerce
HTTP API
Enhancement
OrdersProject configuration
You can now assign an order to a Store when using the Order Import API.

OAuth 2.0 Scope for published product projections

4 September 2019
Composable Commerce
HTTP API
Enhancement
Product catalogSecurity and privacy
Added the view_published_products:{projectKey} OAuth scope. The view_published_products:{projectKey} is used with product projections endpoints. When used, it only retrieves published product projections

Introducing Stores for Customers in Beta

29 August 2019
Composable Commerce
HTTP API
Enhancement
CustomersGraphQLSecurity and privacyProject configuration

You can now assign customer accounts to stores. This allows you to restrict a customer's login and associated carts to a specific store. This is useful for multi-store setups.

Introduced methods to the HTTP API that allow you to access customers belonging to a specific store. They can be used with an OAuth scope like manage_customers:acme-inc:luxury-brand.
When using stores, a customer can either register globally, or have a registration specific to a store. For more information, see Global versus store specific customers.

Additional key fields in Discount Predicates

26 August 2019
Composable Commerce
HTTP API
Enhancement
Pricing and Discounts
Added support for accessing more resources by their key field in Discount Predicate Field Identifiers. You can now use the following in discount predicates:
  • ProductDiscount Predicate Field Identifiers
    • productType.key
    • categories.key
    • categoriesWithAncestors.key
    • price.channel.key
  • Cart Predicate Field Identifiers
    • customer.key
    • <address-field>.key
    • shippingInfo.taxCategory.key
    • shippingInfo.shippingMethod.key
  • Cart Target
    • LineItemPredicate Identifiers
      • productType.key
      • supplyChannel.key
      • price.channel.key
    • CustomLineItemPredicate
      • taxCategory.key

GraphQL new custom fields

20 August 2019
Composable Commerce
HTTP API
Enhancement
Deprecation
ExtensibilityGraphQL
The customFields field on GraphQL queries is deprecated in favor of the new custom field. customFields is still available for use in queries, but we strongly encourage all users to switch to using custom in GraphQL queries. For more information about this change, see Beta Features.
We are deprecating the existing customFields graphQL field present on all fields having custom fields for a better alternative.
In the new approach, all fields having custom fields have the new custom field exposes the following sub-fields:
type RawCustomField { name: String! value: Json! } type CustomFieldsType { typeRef: Reference! type: TypeDefinition "This field contains non-typed data. For a typed alternative, have a look at `customFields`." customFieldsRaw( includeNames: [String!], excludeNames: [String!]): [RawCustomField!] "This field contains typed data" customFields: Type! }
The customFields provides access to typed custom fields.
The new custom field improves the performance of the query as long as you don't use typed fields. For example:
fragment customFields on ProducePrice { custom { typeRef { id } rawCustomFields { name value } } }
If you use custom.customFields then you won't profit from the better performance.
  • [GraphQL API] Added the following types to the GraphQL schema: CustomFieldsType.
  • [GraphQL API] Changed the Category type:
    • Added the custom field to the Category type.
    • Field customFieldsRaw was deprecated in Category type
    • Field customFields was deprecated in Category type
  • [GraphQL API] Changed the Channel type:
    • Added the custom field to the Channel type.
    • Field customFields was deprecated in Channel type
    • Field customFieldsRaw was deprecated in Channel type
  • [GraphQL API] Changed the ProductPrice type:
    • Added the custom field to the ProductPrice type.
    • Field customFieldsRaw was deprecated in ProductPrice type
    • Field customFields was deprecated in ProductPrice type
  • [GraphQL API] Changed the Cart type:
    • Added the custom field to the Cart type.
    • Field customFieldsRaw was deprecated in Cart type
    • Field customFields was deprecated in Cart type
  • [GraphQL API] Changed the CustomerGroup type:
    • Added the custom field to the CustomerGroup type.
    • Field customFieldsRaw was deprecated in CustomerGroup type
    • Field customFields was deprecated in CustomerGroup type
  • [GraphQL API] Changed the Asset type:
    • Added the custom field to the Asset type.
    • Field customFields was deprecated in Asset type
    • Field customFieldsRaw was deprecated in Asset type
  • [GraphQL API] Changed the CustomLineItem type:
    • Added the custom field to the CustomLineItem type.
    • Field customFields was deprecated in CustomLineItem type
    • Field customFieldsRaw was deprecated in CustomLineItem type
  • [GraphQL API] Changed the Customer type:
    • Added the custom field to the Customer type.
    • Field customFieldsRaw was deprecated in Customer type
    • Field customFields was deprecated in Customer type
  • [GraphQL API] Changed the CartDiscount type:
    • Added the custom field to the CartDiscount type.
    • Field customFields was deprecated in CartDiscount type
    • Field customFieldsRaw was deprecated in CartDiscount type
  • [GraphQL API] Changed the Payment type:
    • Added the custom field to the Payment type.
    • Field customFieldsRaw was deprecated in Payment type
    • Field customFields was deprecated in Payment type
  • [GraphQL API] Changed the CategorySearch type:
    • Added the custom field to the CategorySearch type.
    • Field customFields was deprecated in CategorySearch type
    • Field customFieldsRaw was deprecated in CategorySearch type
  • [GraphQL API] Changed the Order type:
    • Added the custom field to the Order type.
    • Field customFieldsRaw was deprecated in Order type
    • Field customFields was deprecated in Order type
  • [GraphQL API] Changed the InventoryEntry type:
    • Added the custom field to the InventoryEntry type.
    • Field customFields was deprecated in InventoryEntry type
    • Field customFieldsRaw was deprecated in InventoryEntry type
  • [GraphQL API] Changed the LineItem type:
    • Added the custom field to the LineItem type.
    • Field customFields was deprecated in LineItem type
    • Field customFieldsRaw was deprecated in LineItem type
  • [GraphQL API] Changed the DiscountCode type:
    • Added the custom field to the DiscountCode type.
    • Field customFields was deprecated in DiscountCode type
    • Field customFieldsRaw was deprecated in DiscountCode type

Added new messages for products

19 August 2019
Composable Commerce
HTTP API
Enhancement
Messages/SubscriptionsProduct catalog
Adding and removing a product from a category now triggers messages.

Use Customer's key field in Cart Discount Predicates

21 June 2019
Composable Commerce
HTTP API
Enhancement
CartsCustomersPricing and Discounts
You can now use a Customer's key field in Cart Discount Predicates.

User defined key attribute on Product Discount

4 June 2019
Composable Commerce
HTTP API
Enhancement
GraphQLPricing and DiscountsProduct catalog
Product Discounts now have a user defined key attribute. You can use the key attribute when querying, updating, or deleting a ProductDiscount.
  • [API] Added the key attribute on the ProductDiscount and ProductDiscountDraft representations.
  • [API] You can now get, update, and delete a Product Discount by its key.
  • [GraphQL API] Added the following types to the GraphQL schema: SetProductDiscountKey.
  • [GraphQL API] Changed the ProductDiscount type:
    • Added the key field to the ProductDiscount type.
  • [GraphQL API] Changed the ProductDiscountUpdateAction type:
    • Input field setKey was added to ProductDiscountUpdateAction type
  • [GraphQL API] Changed the Mutation type:
    • Mutation.updateProductDiscount(id) description is changed
    • Argument key was added to Mutation.updateProductDiscount field
    • Mutation.deleteProductDiscount(id) description is changed
    • Mutation.updateProductDiscount(id) type changed from String! to String
    • Mutation.deleteProductDiscount(id) type changed from String! to String
    • Argument key was added to Mutation.deleteProductDiscount field

HTTP API methods for Stores in Beta

4 June 2019
Composable Commerce
HTTP API
Enhancement
CartsOrdersSecurity and privacyProject configuration
Introduced methods to the HTTP API that allow you to access carts and orders belonging to a specific store. They can be used with an OAuth scope like manage_orders:acme-inc:luxury-brand.

New update actions for custom types

28 May 2019
Composable Commerce
HTTP API
Enhancement
Extensibility
Added new update actions for Custom Types. You can now update the inputHint of a FieldDefinition for StringType and LocalizedStringType and their Set equivalents. In addition, you can also update the labels of enum values.

User defined key attribute on Cart Discount

27 May 2019
Composable Commerce
HTTP API
Enhancement
CartsGraphQLPricing and Discounts
Added the key attribute to CartDiscount. You can use the key attribute when creating or updating a CartDiscount.
  • [API] Added the key attribute to the CartDiscount and CartDiscountDraft representations.
  • [API] Added the Get CartDiscount by Key, Update CartDiscount by Key, and Delete CartDiscount by Key endpoints.
  • [GraphQL API] The GraphQL API now supports queries and mutations of CartDiscount by the key attribute.
  • [GraphQL API] Added the following types to the GraphQL schema: SetCartDiscountKey.
  • [GraphQL API] Changed the CartDiscountDraft type:
    • Input field key was added to CartDiscountDraft type
  • [GraphQL API] Changed the Query type:
    • Query.cartDiscount(id) description is changed
    • Argument key was added to Query.cartDiscount field
    • Query.cartDiscount(id) type changed from String! to String
  • [GraphQL API] Changed the CartDiscount type:
    • Added the key field to the CartDiscount type.
  • [GraphQL API] Changed the CartDiscountUpdateAction type:
    • Input field setKey was added to CartDiscountUpdateAction type
  • [GraphQL API] Changed the Mutation type:
    • Mutation.updateCartDiscount(id) type changed from String! to String
    • Mutation.deleteCartDiscount(id) description is changed
    • Argument key was added to Mutation.updateCartDiscount field
    • Mutation.deleteCartDiscount(id) type changed from String! to String
    • Argument key was added to Mutation.deleteCartDiscount field
    • Mutation.updateCartDiscount(id) description is changed

deleteDaysAfterLastModification field is out of Beta

16 May 2019
Composable Commerce
HTTP API
Enhancement
Carts
The deleteDaysAfterLastModification field has been taken out of Beta. The field's current functionality has not changed.

Added the lastModifiedBy and createdBy fields

14 May 2019
Composable Commerce
HTTP API
Enhancement
Security and privacy
Added the lastModifiedBy and createdBy fields to many representations in the API. These fields add change history information for API calls to these resources as of 2019-02-01. Resources created or last modified before 2019-02-01 will not contain these fields. The fields only track changes from direct API calls by the Merchant Center or client applications. The fields may not track changes from the Admin Center, or from internal background services, like product discount or inventory updates.
Client applications can also use a new HTTP header, X-External-User-ID, when making API calls to track changes initiated by a specific user's actions. The lastModifiedBy and createdBy fields return this ID if it is provided. Do not pass personally identifying information using the X-External-User-ID header. See Client Logging for more information.

Added GraphQL support for Project

8 May 2019
Composable Commerce
HTTP API
Enhancement
GraphQLSearch
  • [GraphQL API] The following types were added in the GraphQL schema: ProjectProjection, ShippingRateInputType, MessagesConfiguration, ShippingRateInputType, CartScoreType, CartValueType, CartClassificationType, ShippingRateInputLocalizedEnumValue, LocalizedEnumValueInput, YearMonth.
  • [GraphQL API] Type Query was changed:
    • Field project was added to Query type
  • [GraphQL API] Type Mutation was changed:
    • Field updateProject was added to Mutation type

Authorization Header Usage

29 April 2019
Composable Commerce
HTTP API
Announcement
Deprecation
Security and privacy
As a security improvement, on 6 May 2019 the commercetools Composable Commerce API endpoints will no longer accept access tokens as URI parameters.
All API Clients should provide access tokens using the Authorization header as follows:
POST /{{projectKey}}/channels HTTP/1.1 Host: api.{region}.{cloudProvider}.commercetools.com Authorization: Bearer {accesstoken} ...

For more information, see:

Introducing Stores in Beta

17 April 2019
Composable Commerce
HTTP API
Enhancement
CartsGraphQLOrdersSecurity and privacyProject configuration

Stores let you model the context your customers shop in, for example physical retail locations, brand stores, or country-specific stores. Currently, a store holds carts and orders. During the Beta phase, we plan to let the store define what subset of resources within a project is available in the context of the store. For example, which products are sold at what price, and which currency or shipping methods can be used.

Additionally, a store can be used for permissions. With an OAuth scope like manage_orders:acme-inc:luxury-brand, an API client can only work with carts and orders inside the luxury-brand store, but not within the budget-brand store. See the GraphQL section for more details. Coming soon to the Merchant Center, a team can be given permission to only work with orders from one store.
  • [API] Added the new resource Store.
  • [API] Added the type KeyReference.
  • [API] Cart and Order have a new field store.
  • [API] When creating a Cart, the store can be referenced by its ID or key.
  • [API] New OAuth scopes manage_stores:{projectKey} and view_stores:{projectKey}.
  • [API] New store-based OAuth scopes manage_orders:{projectKey}:{storeKey} and view_orders:{projectKey}:{storeKey}.
  • [GraphQL API] Added Stores, and the store fields on the types Cart, CartDraft and Order.
  • [GraphQL API] Added the query fields inStore and inStores, as well as a storeKey argument to cart and order mutations. These can be used with the new store-based OAuth scopes.

{/* */}

External OAuth tokens (Beta)

25 March 2019
Composable Commerce
HTTP API
Enhancement
CustomersSecurity and privacy
We introduced the ability to use External OAuth tokens in Beta.
The new OAuth scopes customer_id:{id} and anonymous_id:{id} have been added for external OAuth tokens that are to be used with the /me endpoints. They are also added when a token is issued through the password flow or when an anonymous session is created.

API Extension timeout is configurable

22 March 2019
Composable Commerce
HTTP API
Enhancement
ExtensibilityLimits
The maximum time commercetools Composable Commerce waits for a response from an API Extension is now configurable. The maximum timeout is still limited to 2000 ms. This limit can be increased per project after we review the performance impact. Please contact the Composable Commerce support team and provide the region, project key and use case.

Set discounted prices from an external service when creating a Price

19 March 2019
Composable Commerce
HTTP API
Enhancement
Pricing and Discounts
You can now set a discounted price for a product from an external service when creating the product's PriceDraft. This reduces API calls when using an external service to manage product discounts.

Introduced Limits on Products and Categories

21 February 2019
Composable Commerce
HTTP API
Announcement
LimitsProduct catalog
Introduced new limits for new projects on commercetools Composable Commerce for products and categories.

The new limits and their defaults are:

  • Product variants per product: 100
  • Categories per project: 10000

The following existing limits have been lowered:

  • Query maximum offset: lowered from 100000 to 10000
  • Search maximum offset: lowered from 100000 to 10000
  • Prices per product variant: lowered from 700 to 100

Projects created before 2019-02-21 are not subject to the new limits listed above.

For newer projects, all of the limits listed above can be increased if needed after we have reviewed the performance impact on your project. To request a limit increase, please contact the Composable Commerce support team, specifying your project region, project key, and your use case.

Cart and Order as Reference Type

24 January 2019
Composable Commerce
HTTP API
Enhancement
CartsExtensibilityOrders
You can now use Cart and Orders as ReferenceTypes when creating a Custom Type.

Payments available in the GraphQL schema

21 January 2019
Composable Commerce
HTTP API
Enhancement
GraphQLPayments

You can now access payments and related information using the GraphQL schema.

  • [GraphQL API] Added the following types to the GraphQL schema: Payment, PaymentMethodInfo, PaymentQueryResult, PaymentStatus, Transaction, TransactionState, TransactionType.
  • [GraphQL API] Changed the Query type:
    • Added the payments field to the Query type.
    • Added the payment field to the Query type.
  • [GraphQL API] Changed the PaymentInfo type:
    • Added the payments field to the PaymentInfo type.

Orders mutations available in the GraphQL schema

21 January 2019
Composable Commerce
HTTP API
Enhancement
GraphQLOrders

You can now update orders using the GraphQL schema.

  • [GraphQL API] Added the following types to the GraphQL schema: AddOrderDelivery, AddOrderItemShippingAddress, AddOrderParcelToDelivery, AddOrderPayment, AddOrderReturnInfo, ChangeOrderPaymentState, ChangeOrderShipmentState, ChangeOrderState, DeliveryItemDraftType, ImportOrderCustomLineItemState, ImportOrderLineItemState, ItemShippingDetailsDraftType, ItemStateDraftType, OrderCartCommand, OrderMyCartCommand, OrderUpdateAction, ParcelMeasurementsDraftType, RemoveOrderDelivery, RemoveOrderItemShippingAddress, RemoveOrderParcelFromDelivery, RemoveOrderPayment, ReturnItemDraftType, SetOrderBillingAddress, SetOrderCustomField, SetOrderCustomLineItemCustomField, SetOrderCustomLineItemCustomType, SetOrderCustomLineItemShippingDetails, SetOrderCustomType, SetOrderCustomerEmail, SetOrderCustomerId, SetOrderDeliveryAddress, SetOrderDeliveryItems, SetOrderLineItemCustomField, SetOrderLineItemCustomType, SetOrderLineItemShippingDetails, SetOrderLocale, SetOrderNumber, SetOrderParcelItems, SetOrderParcelMeasurements, SetOrderParcelTrackingData, SetOrderReturnPaymentState, SetOrderReturnShipmentState, SetOrderShippingAddress, ShippingTargetDraftType, TrackingDataDraftType, TransitionOrderCustomLineItemState, TransitionOrderLineItemState, TransitionOrderState, UpdateOrderItemShippingAddress, UpdateOrderSyncInfo.
  • [GraphQL API] Changed the Mutation type:
    • Added the updateOrder field to the Mutation type.
    • Added the createOrderFromCart field to the Mutation type.
    • Added the createMyOrderFromCart to the Mutation type.
    • Added the deleteOrder field to the Mutation type.

Change attribute definition order by name

21 January 2019
Composable Commerce
HTTP API
Enhancement
Product catalog
Introduced a new update action which changes the order of a ProductTypes' AttributeDefinitions by providing the attribute definition's names.
  • [API] Added the "changeAttributeOrderByName" update action to ProductTypes.
  • [API] Removed the "changeAttributeOrder" update action from documentation. Existing calls to the "changeAttributeOrder" update action are unaffected, but new projects should use"changeAttributeOrderByName".

Add ProductVariant update action now includes an assets field

15 January 2019
Composable Commerce
HTTP API
Enhancement
Product catalog
The Add ProductVariant update action now includes an assets field for providing images when creating a Product Variant.

External Tax Rate supports includedInPrice

8 January 2019
Composable Commerce
HTTP API
Enhancement
Carts
For carts with taxMode External, it is now possible to set includedInPrice to either true or false in the ExternalTaxRateDraft.

Manage API Clients using the GraphQL API and delete clients after a specified amount of time.

7 January 2019
Composable Commerce
HTTP API
Enhancement
GraphQLSecurity and privacy
You can now manage API Clients using the GraphQL API. In addition, API Clients have a new deleteDaysAfterCreation field, which lets you delete a client after a specified amount of days.
  • [API] Added the deleteDaysAfterCreation field to the APIClientDraft.
  • [API] Added the deleteAt field to the APIClient.
  • [GraphQL API] Added API Clients to the GraphQL API.

Reference Channels by their key

4 January 2019
Composable Commerce
HTTP API
Enhancement
CartsOrdersProduct catalog
You can now reference a Channel using a user-defined key field in the following scenarios:

Orders available in the GraphQL schema

2 January 2019
Composable Commerce
HTTP API
Enhancement
GraphQLOrders

You can now access orders and related information using the GraphQL schema.

  • [GraphQL API] Added the following types to the GraphQL schema: CustomLineItemReturnItem, LineItemReturnItem, Order, OrderQueryResult, OrderState, PaymentState, ReturnInfo, ReturnItem, ReturnPaymentState, ReturnShipmentState, ShipmentState, SyncInfo.
  • [GraphQL API] Changed the Me type:
    • Added the orders field to the Me type
    • Added the order field to the Me type
  • [GraphQL API] Changed the Query type:
    • Added the orders field to the Query type
    • Added the order field to the Query type

Introduced ShippingInfoImportDraft representation

19 December 2018
Composable Commerce
HTTP API
Enhancement
CartsOrdersPricing and DiscountsProduct catalog
Introduced the new ShippingInfoImportDraft representation. This representation improves the Order Import API by importing more robust shipping information.
In addition, you can now reference the following fields by their key, instead of just their id value when performing a set or update action:

This lets you perform set and update actions with more flexibility.

Improved product projection search for several languages

30 November 2018
Composable Commerce
HTTP API
Enhancement
Search
  • [API] Improved Product Projection Search, in particular text analysis during a full text search, for the following languages:
    • Korean (language tag ko)
    • Polish (language tag pl)
    • Latvian (language tag lv)
    • Slovak (language tag sk)

API for API Clients

23 November 2018
Composable Commerce
HTTP API
New feature
Security and privacy

Introduced a new API resource for managing API Clients. This is especially useful for infrastructure-as-code tooling, as well as for API secrets rotating on a regular basis.

  • [API] New OAuth scopes manage_api_clients:{projectKey} and view_api_clients:{projectKey}
  • [API] New endpoint for managing API Clients

Added Assets to Category Search

19 November 2018
Composable Commerce
HTTP API
Enhancement
GraphQLProduct catalogSearch
It is now possible to retrieve category assets via GraphQL API category search and category auto completion.

User defined key attribute on Shipping Zones

15 November 2018
Composable Commerce
HTTP API
Enhancement
CartsOrders
Shipping Zones now have a user defined key attribute. The key attribute is used when creating or updating a ShippingMethod to identify a Zone.

Introduced a customerNumber field in the UserProvidedIdentifiers

6 November 2018
Composable Commerce
HTTP API
Enhancement
CustomersMessages/Subscriptions
Introduced a new field on Messages that uniquely identifies which Customer is concerned with the message.
  • [API] Added field customerNumber in the UserProvidedIdentifiers of messages.
    This field will only be filled if the customerNumber field on the respective Customer has a value.

ReturnItems for CustomLineItems

6 November 2018
Composable Commerce
HTTP API
Enhancement
Orders
It is now possible to handle returns for goods that were ordered as CustomLineItems by including a customLineItemId on a ReturnItemDraft.

{/*

*/}

Shipping Methods - set or update the Tax Category by Key

18 October 2018
Composable Commerce
HTTP API
Enhancement
Pricing and Discounts
It is now possible to set or update the TaxCategory on a ShippingMethod by its id or by its Key.

Added new messages related to discounted price on products

16 October 2018
Composable Commerce
HTTP API
Enhancement
Messages/SubscriptionsPricing and Discounts
We introduced new Messages that are emitted when the DiscountedPrice on a ProductVariant has changed.

Product projection search - explicit sorting by score

12 October 2018
Composable Commerce
HTTP API
Enhancement
Search

It is now possible to explicitly sort by relevance score in product projection search giving you more control over the order of search results.

OrderEdit dry run

11 October 2018
Composable Commerce
HTTP API
Enhancement
Orders
With this release, it is possible to explicitly trigger a preview of the order when either creating or updating an OrderEdit. This feature is enabled by setting the new parameter dryRun to true.

Documented TTL for token to reset customer password

10 October 2018
Composable Commerce
HTTP API
Resolved issue
Customers
We now documented the parameter to set the life span of the token that is generated for resetting the password of a Customer.

The Messages HTTP API can delete old messages

8 October 2018
Composable Commerce
HTTP API
Enhancement
ExtensibilityMessages/Subscriptions
In the Project Settings, you can configure after how many days messages will be deleted from the Messages Query HTTP API. The default for new projects is 15 days.
Existing projects are not automatically migrated to the new feature. However, we encourage you to manually migrate to ensure a stable performance of the Messages Query HTTP API.
  • [API] The Messages Configuration has a new field deleteDaysAfterCreation.
  • [API] A new update action to change the messages configuration has been added. This supersedes the previous update action changeMessagesEnabled, which has been removed from the documentation (but can still be used for backwards compatibility reasons).

Category and Product Mutations added

2 October 2018
Composable Commerce
HTTP API
Enhancement
GraphQLProduct catalog
It is now possible to create/update/delete categories as well as products via GraphQL API.
  • [GraphQL API] Type Mutation was changed:
    • Field createCategory was added to Mutation type
    • Field updateCategory was added to Mutation type
    • Field deleteCategory was added to Mutation type
    • Field createProduct was added to Mutation type
    • Field updateProduct was added to Mutation type
    • Field deleteProduct was added to Mutation type

Additionally the following query fields where added:

  • [GraphQL API] Type Category was changed:
    • Field assets was added to Category type
  • [GraphQL API] Type ProductVariant was changed:
    • Field assets was added to ProductVariant type
  • [GraphQL API] Type ProductPrice was changed:
    • Field tiers was added to ProductPrice type

HTTPS security changes activated

1 October 2018
Composable Commerce
HTTP API
Announcement
Security and privacy
Following the announcement to update the SSL setup we only support TLS 1.2 for all encrypted connections from now on. We have dropped support for older SSL/TLS versions. For exact details on the SSL/TLS setup that we support, refer to the Security section of the general HTTP API documentation.

Temporary URLs that we provided for application testing are not active anymore.

Add OAuth scope to manage project settings

28 September 2018
Composable Commerce
HTTP API
Enhancement
Security and privacy
  • [API] The new manage_project_settings scope grants access to modifying and viewing the project settings. Previously, only the manage_project scope did.

Added SetLineItemPrice for Orders and OrderCustomerGroupSet message

27 September 2018
Composable Commerce
HTTP API
Enhancement
Messages/SubscriptionsOrdersPricing and Discounts
Prices on line items can now be updated on Orders in the context of Order Edits. A new message has been introduced to get informed about changes on the CustomerGroup of an Order.

Subscriptions out of Beta

19 September 2018
Composable Commerce
HTTP API
Announcement
Messages/Subscriptions
We are announcing that Subscriptions have been taken out of Beta. After releasing several enhancements over the last weeks, this is being done with no further changes to the functionality of Subscriptions.

Shopping List API out of Beta

17 September 2018
Composable Commerce
HTTP API
Announcement
Carts
We are announcing that the Shopping List API has been taken out of Beta. This is being done without any changes or enhancements to the API's current functionality.

Messages and Change Subscriptions now have user-provided identifiers

14 September 2018
Composable Commerce
HTTP API
Enhancement
Messages/Subscriptions
User-provided identifiers are identifiers that are not set by the API (like the id field is), but provided by the API user (like the key or orderNumber fields). In particular the design goal of the key field is to allow client applications to only use the key field, and ignore the API-provided id field.
This release progresses towards the design goal by adding the key field among other user-provided identifiers into data structures commonly used in asynchronous processing by Subscriptions and the Messages Endpoint.

Change Subscriptions now support ten more resource types

13 September 2018
Composable Commerce
HTTP API
Enhancement
Messages/Subscriptions
The following ten resourceTypeIds are now supported by Change Subscriptions:
  • cart-discount
  • channel
  • discount-code
  • extension
  • product-discount
  • shopping-list
  • subscription
  • state
  • tax-category
  • type

Cart updates prices, taxes etc. on every update

12 September 2018
Composable Commerce
HTTP API
Enhancement
CartsPricing and Discounts
Before, the cart decided, based on the update actions, whether to update the product prices and tax rates. We've received feedback that this was unpredictable and confusing.
Therefore, the cart now updates the product prices and tax rates, along with discounts and the shipping info, on every update. No change to your code is necessary, but you may remove superfluous Recalculate update actions (if they don't update the product data).
  • [API] The Update Cart section now contains a description of the updates
  • [API] The description of the Recalculate update action has been changed to reflect the two remaining use cases for it

Added Order Edits

7 September 2018
Composable Commerce
HTTP API
Enhancement
Orders
You can now apply financial changes after an Order has been placed with OrderEdits. OrderEdits are wrappers that capture OrderUpdateActions which can create a preview of changes and apply them to the Order.

This feature is in beta so we do not guarantee that the API is in its final shape.

Added new error codes and extended existing error information

4 September 2018
Composable Commerce
HTTP API
Enhancement
CartsCustomersOrdersPricing and Discounts

We have introduced new error codes that should help you analyzing the root cause of 'Bad Request' type errors by giving more specific error messages.

We have enriched an existing error code with additional information to be more specific on the error cause.

We have added the error code that can occur when removing enum values from an attribute definitions that are still in use by products.

HTTPS security changes

4 September 2018
Composable Commerce
HTTP API
Enhancement
Deprecation
Security and privacy
We are updating the SSL setup to only support TLS 1.2 for all encrypted connections. Starting October 2018, we will drop support for older SSL/TLS versions. For exact details on the SSL/TLS setup that we will support refer to the Security section of the general HTTP API documentation.

For application testing, we offer temporary URLs that already support the new setup. These URLs are available now but only until end of September when the changes go into effect. The test URLs are:

For EU:

  • https://auth-tls12.commercetools.com
  • https://api-tls12.commercetools.com

For US:

  • https://auth-tls12.commercetools.co
  • https://api-tls12.commercetools.co

Please note again that these URLs are for testing purposes only and will be shut down as soon as the main setup has changed.

The SSL setup change as outlined here will go into effect on Monday, 1 October 2018 between 9 and 11 AM (UTC).

Added setValidFromAndUntil to cart discounts and discount codes

28 August 2018
Composable Commerce
HTTP API
Enhancement
CartsGraphQLPricing and Discounts
It is now possible to set the validFrom and validUntil values for CartDiscounts and DiscountCode in the same update action. We also added support for these update actions to the GraphQL API.

Add GraphQL queries for State

27 August 2018
Composable Commerce
HTTP API
Enhancement
GraphQL
Query for States is now supported on the GraphQL API too.
  • [GraphQL API] Type Query was extended:
    • Field states was added to Query type.
    • Field state was added to Query type.
  • [Documentation] Fix documentation of State:
    • The field name is optional.
    • The field description is optional.
  • [Documentation] Fix documentation of StateDraft:

Order Deleted Message

27 August 2018
Composable Commerce
HTTP API
Enhancement
Messages/SubscriptionsOrders

You can now be notified about deletion of orders that have been created for test purposes, for instance.

Added reference expansion on more shipping method related endpoints

27 August 2018
Composable Commerce
HTTP API
Enhancement
Carts
We have extended the support for Reference Expansion to ShippingMethod-related endpoints.

Added GraphQL support for Carts

14 August 2018
Composable Commerce
HTTP API
Enhancement
CartsCustomersGraphQL
  • [GraphQL API] The following types were added in the GraphQL schema: AddCartCustomLineItem, AddCartDiscountCode, AddCartItemShippingAddress, AddCartLineItem, AddCartPayment, AddCartShoppingList, AddMyCartLineItem, ApplyCartDeltaToCustomLineItemShippingDetailsTargets, ApplyCartDeltaToLineItemShippingDetailsTargets, BaseMoneyInput, Cart, CartDraft, CartOrigin, CartQueryResult, CartState, CartUpdateAction, ChangeCartCustomLineItemMoney, ChangeCartCustomLineItemQuantity, ChangeCartLineItemQuantity, ChangeCartTaxCalculationMode, ChangeCartTaxMode, ChangeCartTaxRoundingMode, ChangeMyCartTaxMode, ClassificationShippingRateInput, ClassificationShippingRateInputDraft, CustomLineItem, CustomLineItemDraft, Delivery, DeliveryItem, DiscountCodeInfo, DiscountCodeState, DiscountedLineItemPortion, DiscountedLineItemPrice, DiscountedLineItemPriceForQuantity, ExternalLineItemTotalPriceDraft, ExternalTaxAmountDraft, ExternalTaxRateDraft, HighPrecisionMoneyInput, InventoryMode, ItemShippingDetails, ItemShippingDetailsDraft, ItemShippingTarget, ItemState, LineItem, LineItemDraft, LineItemMode, LineItemPriceMode, MyCartDraft, MyCartUpdateAction, MyLineItemDraft, Parcel, ParcelMeasurements, PaymentInfo, RecalculateCart, RemoveCartCustomLineItem, RemoveCartDiscountCode, RemoveCartItemShippingAddress, RemoveCartLineItem, RemoveCartPayment, RoundingMode, ScoreShippingRateInput, ScoreShippingRateInputDraft, SetCartAnonymousId, SetCartBillingAddress, SetCartCountry, SetCartCustomField, SetCartCustomLineItemCustomField, SetCartCustomLineItemCustomType, SetCartCustomLineItemShippingDetails, SetCartCustomLineItemTaxAmount, SetCartCustomLineItemTaxRate, SetCartCustomShippingMethod, SetCartCustomType, SetCartCustomerEmail, SetCartCustomerGroup, SetCartCustomerId, SetCartDeleteDaysAfterLastModification, SetCartLineItemCustomField, SetCartLineItemCustomType, SetCartLineItemPrice, SetCartLineItemShippingDetails, SetCartLineItemTaxAmount, SetCartLineItemTaxRate, SetCartLineItemTotalPrice, SetCartLocale, SetCartShippingAddress, SetCartShippingAddressAndCustomShippingMethod, SetCartShippingAddressAndShippingMethod, SetCartShippingMethod, SetCartShippingMethodTaxAmount, SetCartShippingMethodTaxRate, SetCartShippingRateInput, SetCartTotalTax, SetCustomerGroup, SetCustomerNumber, SetMyCartShippingMethod, ShippingInfo, ShippingMethodState, ShippingRateInput, ShippingRateInputDraft, ShippingTargetDraft, TaxCalculationMode, TaxMode, TaxPortion, TaxPortionDraft, TaxedItemPrice, TaxedPrice, TrackingData, UpdateCartItemShippingAddress.
  • [GraphQL API] The following types were removed from the GraphQL schema: SetCustomerCustomerGroup, SetCustomerCustomerNumber.
  • [GraphQL API] Type Me was changed:
    • Field carts was added to Me type
    • Field activeCart was added to Me type
    • Field cart was added to Me type
  • [GraphQL API] Type Query was changed:
    • Field carts was added to Query type
    • Field cart was added to Query type
    • Field customerActiveCart was added to Query type
  • [GraphQL API] Type CustomerSignInResult was changed:
    • Field cart was added to CustomerSignInResult type
  • [GraphQL API] Type CustomerUpdateAction was changed:
    • CustomerUpdateAction.setCustomerGroup input field type changed from SetCustomerCustomerGroup to SetCustomerGroup
    • CustomerUpdateAction.setCustomerNumber input field type changed from SetCustomerCustomerNumber to SetCustomerNumber
  • [GraphQL API] Type Mutation was changed:
    • Field deleteCart was added to Mutation type
    • Field deleteMyCart was added to Mutation type
    • Field createMyCart was added to Mutation type
    • Field updateMyCart was added to Mutation type
    • Field updateCart was added to Mutation type
    • Field replicateCart was added to Mutation type
    • Field createCart was added to Mutation type

Removed IronMQ from the documentation

9 August 2018
Composable Commerce
HTTP API
Announcement
Deprecation
Messages/Subscriptions
Due to low adoption in the customer base, we have removed IronMQ from the Subscription documentation. We continue to support IronMQ for customers that are already using it.

Subscriptions indicate Health Status

8 August 2018
Composable Commerce
HTTP API
Enhancement
Messages/Subscriptions
Subscriptions now have a HealthStatus allowing you to monitor the health of a subscription with a tool of your choice. For production-critical queues, we recommend setting up an automatic alert.
With the new update action changeDestination, a ConfigurationError can be fixed (common causes are deleting the destination queue, deleting the access credentials, or removing the permission to push messages into the queue).
We have modified the handling of delivery failures caused by ConfigurationErrors:
  • A production project has up to 24 hours to fix the configuration
  • A development or staging project has up to an hour to fix the configuration
After that, we'll drop the messages, and will not attempt to deliver further messages. In this case, the subscription gets the status ConfigurationErrorDeliveryStopped. For more information, see the updated Delivery Guarantees.

The product discount limit was increased to 500

7 August 2018
Composable Commerce
HTTP API
Enhancement
Pricing and Discounts

The product discount limit was increased to 500.

Subscriptions and Extensions hide access secrets

3 August 2018
Composable Commerce
HTTP API
Enhancement
ExtensibilityMessages/SubscriptionsSecurity and privacy
Both Subscriptions and API Extensions can contain access secrets, for example to allow commercetools Composable Commerce to place a message into a queue, or to invoke an AWS Lambda function. When retrieving an access secret via the commercetools Composable Commerce API, it is now hidden (except for the last 4 characters).
This change should help you to keep your access secrets secure. As noted in both Subscriptions and API Extensions, we recommend to create access credentials that only have the permission to put a message into the specific message queue, or only invoke the particular API Extension.

Order Update Action - setCustomerId

1 August 2018
Composable Commerce
HTTP API
Enhancement
CustomersOrders
It is now possible to set the Customer ID on an existing Order. A respective Message is now generated upon such changes so that clients can subscribe to it, if interested.

Changes in the GraphQL schema

20 July 2018
Composable Commerce
HTTP API
Enhancement
CustomersGraphQL
  • [GraphQL API] Following types were added in the GraphQL schema: ChangeCustomerGroupName, CustomerGroupDraft, CustomerGroupUpdateAction, SetCustomerGroupCustomField, SetCustomerGroupCustomType, SetCustomerGroupKey.
  • [GraphQL API] Type CustomerGroup was changed:
    • Field customFieldsRaw was added to CustomerGroup type
  • [GraphQL API] Type Mutation was changed:
    • Field updateCustomerGroup was added to Mutation type
    • Field deleteCustomerGroup was added to Mutation type
    • Field createCustomerGroup was added to Mutation type

Subscriptions support Google Cloud Pub/Sub

18 July 2018
Composable Commerce
HTTP API
Enhancement
Messages/Subscriptions
The Subscriptions support Google Cloud Pub/Sub as a destination. It can be used both as a pull-queue, and to push messages to for example Google Cloud Functions or HTTP endpoints (webhooks).

Added orderState and state field to OrderFromCartDraft

18 July 2018
Composable Commerce
HTTP API
Enhancement
Orders

Change Subscription payloads includes modifiedAt

18 July 2018
Composable Commerce
HTTP API
Enhancement
Messages/Subscriptions
The Change Subscription payloads now have the field modifiedAt.

Added setValidFromAndUntil to product discounts methods

18 July 2018
Composable Commerce
HTTP API
Enhancement
Pricing and Discounts
Added setValidFromAndUntil to product discount update methods.

Changes in the GraphQL schema

12 July 2018
Composable Commerce
HTTP API
Enhancement
GraphQL
  • [GraphQL API] The following types were added in the GraphQL schema: AddCustomerAddress, AddCustomerBillingAddressId, AddCustomerShippingAddressId, Address, AddressContactInfo, AddressInput, AnonymousCartSignInMode, ChangeCustomerAddress, ChangeCustomerEmail, Customer, CustomerQueryResult, CustomerSignInDraft, CustomerSignInResult, CustomerSignMeInDraft, CustomerSignMeUpDraft, CustomerSignUpDraft, CustomerToken, CustomerUpdateAction, Me, MyCustomerUpdateAction, RemoveCustomerAddress, RemoveCustomerBillingAddressId, RemoveCustomerShippingAddressId, SetCustomerCompanyName, SetCustomerCustomField, SetCustomerCustomType, SetCustomerCustomerGroup, SetCustomerCustomerNumber, SetCustomerDateOfBirth, SetCustomerDefaultBillingAddress, SetCustomerDefaultShippingAddress, SetCustomerExternalId, SetCustomerFirstName, SetCustomerKey, SetCustomerLastName, SetCustomerLocale, SetCustomerMiddleName, SetCustomerSalutation, SetCustomerTitle, SetCustomerVatId.
  • [GraphQL API] Type Query was changed:
    • Field customer was added to Query type
    • Field customers was added to Query type
    • Field me was added to Query type
  • [GraphQL API] Type Mutation was changed:
    • Field customerCreatePasswordResetToken was added to Mutation type
    • Field customerCreateEmailVerificationToken was added to Mutation type
    • Field customerSignMeUp was added to Mutation type
    • Field customerConfirmEmail was added to Mutation type
    • Field deleteMyCustomer was added to Mutation type
    • Field deleteCustomer was added to Mutation type
    • Field customerResetMyPassword was added to Mutation type
    • Field updateMyCustomer was added to Mutation type
    • Field customerSignMeIn was added to Mutation type
    • Field updateCustomer was added to Mutation type
    • Field customerChangeMyPassword was added to Mutation type
    • Field customerChangePassword was added to Mutation type
    • Field customerResetPassword was added to Mutation type
    • Field customerConfirmMyEmail was added to Mutation type
    • Field customerSignIn was added to Mutation type
    • Field customerSignUp was added to Mutation type

Subscriptions support CloudEvents and Azure EventGrid (Preview)

12 July 2018
Composable Commerce
HTTP API
Enhancement
Messages/Subscriptions

{/* vale commercetools.DiscriminatoryWords = NO */}

CloudEvents is a specification for describing event data in a common way. CloudEvents seeks to ease event declaration and delivery across services, platforms, and beyond. It is hosted by the Cloud Native Computing Foundation.
CloudEvents is a new effort and it's still under active development. The format is versioned, and we do not plan to offer long-term support for outdated versions yet. Therefore, CloudEvents is currently only offered in Preview, with the goal to give feedback to the CloudEvents working group.
Support for Azure Event Grid has been added, which offers support to filter and route CloudEvents. EventGrid can be used to push messages to Azure Functions, HTTP endpoints (webhooks), and several other Azure tools.
  • [API] Added Format to the Subscriptions API. The CloudEvents format can be used with all of the existing destinations.
  • [API] Added the Azure Event Grid Destination. It can only be used with CloudEvents.

Added GraphQL support for Inventory

11 July 2018
Composable Commerce
HTTP API
Enhancement
GraphQL
  • [GraphQL API] The following types were added in the GraphQL schema: AddInventoryEntryQuantity, ChangeInventoryEntryQuantity, InventoryEntry, InventoryEntryDraft, InventoryEntryQueryResult, InventoryEntryUpdateAction, RemoveInventoryEntryQuantity, SetInventoryEntryCustomField, SetInventoryEntryCustomType, SetInventoryEntryExpectedDelivery, SetInventoryEntryRestockableInDays, SetInventoryEntrySupplyChannel.
  • [GraphQL API] Type Query was changed:
    • Field inventoryEntries was added to Query type
    • Field inventoryEntry was added to Query type
  • [GraphQL API] Type Mutation was changed:
    • Field deleteInventoryEntry was added to Mutation type
    • Field createInventoryEntry was added to Mutation type
    • Field updateInventoryEntry was added to Mutation type

Added error messages

28 June 2018
Composable Commerce
HTTP API
Enhancement
Product catalog
We made the error codes for creation and updates of ProductType more specific to ease error handling for you.
  • [API] Added more specific error messages. Please find details in the Errors documentation.

Added filtering for stock and images on product variants in GraphQL

19 June 2018
Composable Commerce
HTTP API
Enhancement
GraphQLProduct catalog
The GraphQL API now allows you to filter for those ProductVariants that have images or that are available in stock.
  • [GraphQL API] Added filtering parameters isOnStock, stockChannelIds and hasImages to ProductData.variants and ProductData.allVariants.

Change a category parent by resource identifier instead of reference

13 June 2018
Composable Commerce
HTTP API
Enhancement
Product catalog
A category’s parent can now be set using its user-defined key instead of the ID.

More info if the payload of a message subscription had to be dropped

8 June 2018
Composable Commerce
HTTP API
Enhancement
Messages/Subscriptions
When the payload of a message subscription had to be dropped (usually due to a size constraint of the destination message queue), the reason as well as the value of the type field is placed into the notification.

Set shipmentState when ordering a cart

6 June 2018
Composable Commerce
HTTP API
Enhancement
CartsOrders

The shipmentState can now be set when creating an order from a cart. Before, it was only settable by an update action, requiring an additional API call.

Changes in Cart Discounts StackingMode StopAfterThisDiscount Behavior

1 June 2018
Composable Commerce
HTTP API
Enhancement
Pricing and Discounts
Based on customer feedback we changed the behavior of the StackingMode StopAfterThisDiscount.
  • [API] The StackingMode StopAfterThisDiscount now continues with further discounts if the discount could not be applied because the CartDiscountTarget did not match. Previously, the application of further discounts was stopped even if the target condition was not fulfilled.

Payment API out of Beta

31 May 2018
Composable Commerce
HTTP API
Announcement
Payments

As part of a Beta improvement initiative, we've announced breaking changes to the Payment API in September. The changes have been applied now, and the Payment API is out of Beta.

GraphQL support for custom fields on category and product price

31 May 2018
Composable Commerce
HTTP API
Enhancement
ExtensibilityGraphQLPricing and DiscountsProduct catalog

Custom fields on category and product price are now supported on GraphQL endpoint.

GDPR tutorial

31 May 2018
Composable Commerce
HTTP API
Enhancement
Security and privacy

We have published a tutorial about how commercetools Composable Commerce fulfills the requirements of the General Data Protection Regulations.

Added GraphQL mutations for the CartDiscount and ProductDiscount

30 May 2018
Composable Commerce
HTTP API
Enhancement
GraphQLPricing and Discounts
Mutations for the CartDiscount and ProductDiscount are now supported on the GraphQL endpoint.
  • [GraphQL API] Following types were added in the GraphQL schema:
    • AbsoluteDiscountValueInput, CartDiscountDraft, CartDiscountTargetInput, CartDiscountUpdateAction, CartDiscountValueInput, ChangeCartDiscountCartPredicate, ChangeCartDiscountIsActive, ChangeCartDiscountName, ChangeCartDiscountRequiresDiscountCode, ChangeCartDiscountSortOrder, ChangeCartDiscountStackingMode, ChangeCartDiscountTarget, ChangeCartDiscountValue, CustomLineItemsTargetInput, ExternalDiscountValueInput, GiftLineItemValueInput, LineItemsTargetInput, MoneyInput, MultiBuyCustomLineItemsTargetInput, MultiBuyLineItemsTargetInput, ProductDiscountDraft, ProductDiscountValueInput, RelativeDiscountValueInput, SetCartDiscountCustomField, SetCartDiscountCustomType, SetCartDiscountDescription, SetCartDiscountValidFrom, SetCartDiscountValidUntil, ShippingTargetInput.
  • [GraphQL API] Type ProductDiscount was changed:
    • ProductDiscount type description is changed
  • [GraphQL API] Type Mutation was changed:
    • Field updateProductDiscount was added to Mutation type
    • Field updateCartDiscount was added to Mutation type
    • Field deleteProductDiscount was added to Mutation type
    • Field createProductDiscount was added to Mutation type
    • Field createCartDiscount was added to Mutation type
    • Field deleteCartDiscount was added to Mutation type

Data Erasure of Personal Data

24 May 2018
Composable Commerce
HTTP API
Enhancement
Security and privacy
In some countries, especially the ones in the European Union, you are required by law (such as the GDPR) to erase personal data of a customer on request, also known as Right to be Forgotten.
A default DELETE request may not clean up all data, both visible at the HTTP API layer (for example personal data may be part of messages) and invisible (commercetools Composable Commerce internally keeps logs for some time, to reconstruct data in case of faulty system behavior).
Endpoints that store personal data therefore offer a parameter for DELETE requests called dataErasure. If set to true, commercetools Composable Commerce guarantees that all personal data related to the particular object, including invisible data, is erased, in compliance with the GDPR. You are, however, responsible for identifying and deleting all objects that belong to a customer, and deleting them.

The parameter is available for:

Personal data must not be stored in objects other than the ones listed above.

High precision prices

9 May 2018
Composable Commerce
HTTP API
Enhancement
Pricing and Discounts
For those businesses whose product prices require a higher precision than the currently offered cent amount, we have extended the pricing model to additionally support sub-cents for ProductVariant prices. To support this, a new money type HighPrecisionMoney was introduced. High precision money usage can be interchanged with regular money usage everywhere where BaseMoney is used.
  • [API] BaseMoney - base polymorphic type which supports cent and high precision at the same time.
  • [API] Money - added fractionDigits and type fields.
  • [API] HighPrecisionMoney - supports definition of sub-cent amounts.
  • Following types have been updated to support high precision prices while keeping everything compatible with cent precision Money:

Customer Group Key can be used on Carts and Customers

2 May 2018
Composable Commerce
HTTP API
Enhancement
CartsCustomers
The user-defined key can now be used on Carts and Customers endpoints to identify a Customer Group.

DiscountCode.applicationCount and ProductVariant.availability in GraphQL schema

27 April 2018
Composable Commerce
HTTP API
Enhancement
GraphQL
  • [GraphQL API] Added new field DiscountCode.applicationCount.
  • [GraphQL API] Product variant info now includes availability information. Since the list of availability per sales channel can get quite big there is a support for pagination and inclusion and exclusion of sales channels.

Correlation ID

25 April 2018
Composable Commerce
HTTP API
Enhancement
Customers
A Correlation ID is a unique identifier of a single action, allowing to trace the action across multiple systems.
  • [API] The API accepts a client-provided Correlation ID if sent with the X-Correlation-ID HTTP header
  • [API] If the client does not provide one, the API generates one and the response contains the X-Correlation-ID HTTP header

Authorization Header for HTTP API Extensions

20 April 2018
Composable Commerce
HTTP API
Enhancement
ExtensibilitySecurity and privacy
It is now possible to provide an Authorization Header when creating a new HTTP API Extension. The Authorization header will be set to the headerValue when the HTTP API Extension is called.
To get started with API Extensions in general, please read the tutorial.

Update Multiple Shipping Addresses for Orders

19 April 2018
Composable Commerce
HTTP API
Enhancement
Orders
When line items of an order should be shipped to different addresses those shipping details can now be updated on orders.
We added the following update actions to Order to manage multiple shipping addresses:
Please find more about usage of multiple shipping addresses in the tutorial.

AWS Lambda API Extensions

17 April 2018
Composable Commerce
HTTP API
Enhancement
Extensibility

You can now create API Extensions natively with AWS Lambda. The AWS Lambda functions are invoked directly (and do not need to go through the AWS API Gateway).

To get started with API Extensions in general, please read the tutorial.

Matching Product Discount Endpoint

29 March 2018
Composable Commerce
HTTP API
Enhancement
Pricing and Discounts
The new matching ProductDiscount endpoint can be used to simulate which product discounts would be applied if a product variant had a specified price.

Orders API Extensions

23 March 2018
Composable Commerce
HTTP API
Enhancement
OrdersExtensibility
You can now extend the behavior of the Orders API with your business logic with the help of API Extensions. An API Extension gets called after the processing of a create or update request of an API call but before the order is persisted. The API Extension can validate the order or apply additional updates to it. It can, for example, validate that an order with the given configuration can be created, automatically add an order number, or change states.
To get started with API Extensions in general, please read the tutorial.

Product type attribute definition management

9 March 2018
Composable Commerce
HTTP API
Enhancement
Product catalog
We have introduced two update actions on the ProductType resource: one to update the name of an attribute definition, and one to update the key of any enum value.

Customer and Payment API Extensions

2 March 2018
Composable Commerce
HTTP API
Enhancement
CustomersExtensibilityPayments

You can now extend the behavior of the Payment API and the Customer API with your business logic with the help of API Extensions. An API Extension gets called after the processing of a create or update request of an API call but before the result is persisted. The API Extension can validate the object or apply additional updates to it. It can, for example, validate that a payment in the given configuration can be processed, or trigger actions with the payment service provider (PSP). Or it can validate that a customer's account details don't look fraudulent, or set a customer group based on the email address.

To get started with API Extensions, you can read the tutorial.

Simplified cart predicate language

2 March 2018
Composable Commerce
HTTP API
Enhancement
Carts
The cart predicate language has been simplified.
  • [API] A boolean value is now a valid predicate. For example if a cart discount should match all carts, the predicate true is now sufficient. Previously, one had to write 1 = 1 or true = true.
  • [API] A boolean function is now a valid predicate. For example lineItemExists(...) is now sufficient. Previously, one had to write lineItemExists(...) = true.

Replicate existing cart or order to a new cart

2 March 2018
Composable Commerce
HTTP API
Enhancement
CartsOrders

We now support creating a new cart by replicating an existing cart or order.

Customer update messages

1 March 2018
Composable Commerce
HTTP API
Enhancement
CustomersMessages/Subscriptions
We have introduced new Messages for updates on the Customer resource. With the introduction of these messages, you can now get notified about changes to specific fields for the Customer. Previously, it was only possible to get the generic change messages with the ChangeSubscription on the Customer resource.
Furthermore, Customer Group has been added as supported resource for ChangeSubscription.

Improvements in GraphQL API coverage

16 February 2018
Composable Commerce
HTTP API
Enhancement
GraphQL
GraphQL API surface area was extended and now includes a lot of new query fields and types, as well as experimental mutation support.

Multiple Shipping Addresses

12 February 2018
Composable Commerce
HTTP API
Enhancement
Carts
It is now possible to capture multiple shipping addresses for one cart. This is done by creating (custom) line item specific shipping addresses. To learn more about this new feature, see the new tutorial.

We added following objects:

We added following fields:

We added following update actions:

We added following error message:

Custom Fields for Customer Groups

2 February 2018
Composable Commerce
HTTP API
Enhancement
CustomersExtensibility
Customer groups can now be extended with custom fields. This allows users to categorize customer groups any way they want and filter the query result by custom fields.

New field origin on cart and order

1 February 2018
Composable Commerce
HTTP API
Enhancement
CartsOrders
Until now it was assumed that carts and orders are created by customers themselves only, but to reflect the case of creating carts and orders by the merchants on behalf of customers also, we introduced a new field tracking the origin of a Cart and an Order.

DiscountCode can now be grouped

29 January 2018
Composable Commerce
HTTP API
Enhancement
OrdersPricing and Discounts
Discount codes now can be grouped together by assigning one or more groups to an individual discount code. Furthermore, the new Return StateRole can now be used to mark the state of those line items that belong to the return process of an order.

Release API Extensions Tutorial

25 January 2018
Composable Commerce
HTTP API
Enhancement
Extensibility
We published a tutorial about the API Extensions feature we recently released. The tutorial explains the usage of the feature based on two example use cases. In the first example an API Extension is developed that validates a maximum number of items that can be added to the cart. The extension developed in the second example will add a mandatory insurance to the cart if any item in the cart is worth $500 or more. Please check it out.
API Extensions can now return a localized description of the error. If available, the Merchant Center will use the correct localization to display the error.

Reference a category parents by its key

15 January 2018
Composable Commerce
HTTP API
Enhancement
Product catalog
When creating a category, the category's parent can now be set by its user-defined key instead of the ID, as it was before. This makes importing of category trees easier since identifiers for all parent categories are known beforehand.

Release API Extensions

10 January 2018
Composable Commerce
HTTP API
Enhancement
Extensibility

With API Extensions, you can extend the behavior of the cart API with your business logic. An API Extension gets called after the processing of a create or update request of an API call, but before the result is persisted. The API Extension can validate the object, or apply additional updates to it. Good use cases for API Extensions are: Validating the content of a cart (for example no more than 8 crates of beverages can be ordered at once), calculating custom shipping costs, or adding mandatory items, like insurance, to a cart.

The first part of the new documentation explains how to setup an extension, while the second part describes the input and the possible responses of the extension. The third part details the limits and error cases related to extensions.

Deliveries with address information

20 December 2017
Composable Commerce
HTTP API
Enhancement
Orders

Deliveries can now be given their own addresses. The delivery address is not to be confused with the shipping address. An order can only have one shipping address based on which the shipping rate is determined. With delivery addresses, however, it is possible to capture multiple fulfillment-related addresses, for example, a customer is stocking up on printing paper and has ordered 80 packages of printing paper; 20 packages are to be delivered to the main office building, 58 to the warehouse and 2 for their home office. This can be achieved by defining three deliveries for the order, each with its own address.

DiscountCode with validity period

19 December 2017
Composable Commerce
HTTP API
Enhancement
Pricing and Discounts

We have introduced validity ranges on Discount Codes for limiting the time range in which a code can be applied to a cart. Setting a validity can also help to manage campaigns which are promoted via discount codes, also considering that one code may contain several different cart discounts with varying validity dates.

"validFrom" and "validUntil" fields in a ProductDiscount

18 December 2017
Composable Commerce
HTTP API
Enhancement
Pricing and Discounts

We have introduced validity periods on Product Discounts to support discounting a (range of) products within a given time frame. Instead of activating product discounts manually, we now allow promotion planning in advance. Please consider that it can take some time to recalculate product discount values. Many discounts with the same validity values may take up to a few minutes to being live.

Update Deliveries

15 December 2017
Composable Commerce
HTTP API
Enhancement
Messages/SubscriptionsOrders
The deliveries of orders can now be amended after creating parcels or deliveries in cases data needs to be added or changed. Corresponding messages have been added, as well as messages for changing the state of the shipment and return shipment to which clients can now subscribe.

New update action for changing Attribute Constraint on a ProductType

6 December 2017
Composable Commerce
HTTP API
Enhancement
Product catalog

In case the 'SameForAll' and 'Unique' constraints on attributes of your product types prevent you from extending your products, you can now change them to 'None'.

Select cart or target line items by custom type key

5 December 2017
Composable Commerce
HTTP API
Enhancement
CartsPricing and Discounts
It is now possible to define Cart Discounts by specifying the custom Type of the line items to be discounted or the line items that activate the discount.

Add key to assets and Add an asset at a specific position

4 December 2017
Composable Commerce
HTTP API
Enhancement
Product catalog
Assets can now be identified by a user-defined key that is unique only within the asset's container (a product variant or a category). Before only the id of the assets could be used to identify them. Assets can now be placed at a specific position within the asset list when adding them to a ProductVariant or a Category.

Revert staged variant

1 December 2017
Composable Commerce
HTTP API
Enhancement
Product catalog

Changes on and deletions of product variants can now be reverted.

Custom Fields for Cart Discount

30 November 2017
Composable Commerce
HTTP API
Enhancement
CartsExtensibilityPricing and Discounts
We now provide custom fields on CartDiscounts. This allows users to customize their cart discounts in any way they want and fetch them by filtering on custom fields now supported on the cart discounts endpoint.

Add Line Item by SKU in Shopping List

17 November 2017
Composable Commerce
HTTP API
Enhancement
Carts
A product variant to be added to a Shopping List and My Shopping List can now be selected by the variant's SKU. Before the variant had to be selected by product ID and variant ID only.

Update of shipping method predicate

16 November 2017
Composable Commerce
HTTP API
Enhancement
CartsOrders
The predicate can now be updated or removed on any existing ShippingMethod. Before it could only be set during creation of shipping methods.

Cart Tax Calculation Mode

15 November 2017
Composable Commerce
HTTP API
Enhancement
Pricing and Discounts
We have introduced the UnitPriceLevel TaxCalculationMode on carts to be able to calculate taxes per unit price and not only per line item as before. The opposite LineItemLevel mode is the default tax calculation mode on the cart so that this new feature does not break any existing application.

Improved customer Sign In

2 November 2017
Composable Commerce
HTTP API
Enhancement
Carts
The customer Sign In now always returns a recalculated cart, and allows to update the product data.
  • [API] Customer Sign In has a new parameter updateProductData to update name, variant and productType in the line item data.
  • [API] My Customer Profile Sign In has a new parameter updateProductData to update name, variant and productType in the line item data.

Keys in Cart and Product Discount predicates

27 October 2017
Composable Commerce
HTTP API
Enhancement
CartsPricing and DiscountsProduct catalog

We added the capability to use user-defined keys of categories, products, and customer groups in predicates for the specification of product and cart discounts. With this it is no longer required to use their IDs in the predicates.

Multi-Buy Discounts for Custom Line Items

26 October 2017
Composable Commerce
HTTP API
Enhancement
Pricing and Discounts
We extended the multi-buy discount feature of type "Buy 4 car tires, get 2 of them 50% off" to CustomLineItems.

Managing orders by order number

25 October 2017
Composable Commerce
HTTP API
Enhancement
Orders
Orders can now be fetched, updated, and deleted by providing the user-defined orderNumber instead of the id field of the order.

Parcel Items

24 October 2017
Composable Commerce
HTTP API
Enhancement
Orders
We now support tracking line items on a Parcel. With this new ability, you can define which line items of a Delivery goes into which parcel. Example: An order consists of fresh fruits and meat products. This will be one delivery, but it will have two parcels. One for the fresh fruits and one for the meat products.
  • [API] Added field items to Parcel.
  • [API] Added field items to Add Parcel update action.
  • [API] Changed field items on Add Delivery update action to be optional.

Added dynamic shipping rates

20 October 2017
Composable Commerce
HTTP API
Enhancement
CartsOrders
With dynamic shipping rates it is now possible to dynamically set the price for shipping based on value or the new ShippingRateInput of the cart. To learn more about this new feature, please see Tiered shipping rates.

Remove enum values from attribute definitions

19 October 2017
Composable Commerce
HTTP API
Enhancement
Product catalog
Enum values can now be removed from enum type and localized enum type attribute definitions of product types.
All attributes of all products using those enum keys will be removed in an eventually consistent way.

Improved Cart's recalculation update action

17 October 2017
Composable Commerce
HTTP API
Enhancement
Carts
We changed the behavior of the Cart's Recalculate update action.
  • [API] Instead of rejecting update requests to recalculate the cart when any of the line items became invalid (for example, because corresponding products don't exist anymore), the relevant items will now be dropped and the recalculation will be executed with only the remaining items.

Cart Discount Stacking Mode

7 October 2017
Composable Commerce
HTTP API
Enhancement
CartsPricing and Discounts
We now support CartDiscounts to prevent further application of matching CartDiscounts respecting their sortOrder. Therefore, a new field stackingMode has been added. The former behaviour of always applying all matching discounts is now encapsulated in the default value of stackingMode: Stacking.

Custom line items behavior improved

6 October 2017
Composable Commerce
HTTP API
Enhancement
Carts
The behavior of CustomLineItems has been improved to behave more similar to regular LineItems when signing in, and when adding a new item.
  • [API] When a customer signs in and the default anonymousCartSignInMode is used, custom line items are merged into the existing customer's cart.
  • [API] When a custom line item is added and an equivalent one already exists in the cart, the quantity is increased.

Payment API deprecating fields

29 September 2017
Composable Commerce
HTTP API
Enhancement
Deprecation
Payments

As part of a Beta improvement initiative, the Payment API has been updated deprecating a series of fields.

  • [API] externalId in PaymentDraft, Payment as well as under Update Payment
    This field has been deprecated because the interfaceId can be used for the ID set by the payment service provider (PSP), and the newly introduced key field has taken over the role of externalID.
  • [API] amountAuthorized, amountPaid and amountRefunded in PaymentDraft, Payment as well as under Update Payment
    These fields have been deprecated because their value can be calculated from the total amounts saved in the Transactions.
    • Example 1: Two transactions, one with type:Charge, state:Success and amount:2$ and another one with type:Charge, state:Success and amount:3$. The amountPaid is 5$.
    • Example 2: Two transactions, one with type:Charge, state:Failure and amount:2$ and another one with type:Charge, state:Success and amount:3$. The amountPaid is 3$.
    • Example 3: Two transactions, one with type:Charge, state:Success and amount:3$ and another one with type:Refund, state:Success and amount:2$. The amountPaid is 3$. The amountRefunded is 2$.
  • [API] authorizedUntil in PaymentDraft, Payment as well as under Update Payment
    We learned the field is of little practical value, as it is either not reliably known, or the authorization time is fixed for a PSP.
  • [API] paymentId in PaymentStatusInterfaceCodeSet Message
    This field has been deprecated because the id in the resource field can be used instead.
  • [API] TransactionType previously had uppercase values like AUTHORIZATION, CHARGE etc. These are deprecated.
Furthermore, another TransactionState has been added.
  • [API] The Initial TransactionState has been added. It is used when the PSP has not accepted the transaction yet (including if the PSP has not been contacted yet). The existing Pending state is from now on used when the PSP has accepted the transaction, but it is not completed yet.
    In the future, we will change the default state value in the TransactionDraft to Initial. Do not depend on the default value! Please set the state field explicitly as soon as possible.

Custom Fields for Discount Codes

28 September 2017
Composable Commerce
HTTP API
Enhancement
ExtensibilityPricing and Discounts
We extended the DiscountCode model to support custom fields. This allows users to categorize discount codes any way they want and fetch them using the predicates on the discount codes endpoint.

Removed originalPrice field in LineItem Predicate

27 September 2017
Composable Commerce
HTTP API
Enhancement
Deprecation
Pricing and Discounts
Since the originalPrice field on the line item predicate was duplicating the behavior of the price field, the originalPrice field was removed.

Project Updates

26 September 2017
Composable Commerce
HTTP API
Enhancement
Extensibility

Get, update and delete payments by key

18 September 2017
Composable Commerce
HTTP API
Enhancement
Payments
We now support getting, updating, and deleting Payments by key. This way payments can be identified by the user-defined key instead of the automatically assigned ID.

Multi-Buy Discounts

15 September 2017
Composable Commerce
HTTP API
Enhancement
Pricing and Discounts

ShippingMethod predicate

14 September 2017
Composable Commerce
HTTP API
Enhancement
Carts
By using predicates on Shipping Methods, we are empowering the merchants to build their own set of shipping method rules. Dependent on the cart and its content, a merchant can define which shipping methods should be offered during checkout. To learn more about predicates, see the Shipping and Delivery Overview.
  • [API] The field predicate was added to ShippingMethod.
  • [API] The field shippingMethodState was added to ShippingInfo.
  • [API] The order-related error code ShippingMethodDoesNotMatchCart was added.

Payment Endpoints for Customers

14 September 2017
Composable Commerce
HTTP API
Enhancement
Payments
We added new endpoints to allow customers to manage their payments with the password flow or with an anonymous session.

Cancel limit for Cart Discount activated by Discount Code

11 September 2017
Composable Commerce
HTTP API
Enhancement
CartsPricing and Discounts

We now removed the limit of cart discounts that are triggered by discount codes. Those discounts were limited to 100 before together with the cart discounts for which no discount code is required.

  • [API] The limit of 100 active CartDiscounts now only applies to cart discounts that do not require a discount code.
  • [API] The number of cart discounts in a DiscountCode is limited to 10.
  • [API] The number of discount codes in a Cart is limited to 10.

External Tax Amount

8 September 2017
Composable Commerce
HTTP API
Enhancement
Pricing and Discounts
The new cart tax mode ExternalAmount allows to set the totalGross, taxRate and taxPortions fields on cart's content externally by the client. This is useful in case you prefer to have those values calculated by a third party service.

Changing mark Matching Variants default behavior

7 September 2017
Composable Commerce
HTTP API
Announcement
Product catalogSearch
Breaking Change
For performance improvements, the "mark-matching-Variants" feature on the Product Projection Search API will be deactivated by default during the week of 11 September 2017. If your project does not require the "mark-matching-Variants" feature for Product Projection Search, no further action is required from your side.
  • [API] If you make use of this feature, you now have to enforce it by explicitly setting the markMatchingVariants parameter to true on requests to this API from next week onwards. Please refer to the documentation on how to set the parameter accordingly.

Added My Shopping List Endpoints

30 August 2017
Composable Commerce
HTTP API
Enhancement
Carts
We added new endpoints to allow Customers to manage their shopping lists with the password flow or with an anonymous session.

Set Anonymous ID on a Cart

24 August 2017
Composable Commerce
HTTP API
Enhancement
Carts

Added an update action to set und unset the anonymous ID of a cart.

Added time based product filters

22 August 2017
Composable Commerce
HTTP API
Enhancement
Product catalog

Products can now be filtered by the times they were created or updated latest.

Keys for Tax Categories

21 August 2017
Composable Commerce
HTTP API
Enhancement
Pricing and Discounts
Added key field to TaxCategories
  • [API] TaxCategories have a new optional field key that allows clients to specify a unique user-specified identifier for the tax category. Keys can be set during creation of the tax category or afterwards by the new update action Set Key. Now tax categories can also be retrieved, updated and deleted by key.

Publish product prices only, Products can be added to a cart by SKU

18 August 2017
Composable Commerce
HTTP API
Enhancement
Product catalog

It is now possible to publish only the prices of a product. This allows you to keep other product information you don't want to publish yet, like updates in the product description, in staged projection while the updated prices will be published already. Product variants to be added to a cart can now be specified by their SKU. Before, the only option was to specify them by their product ID plus variant ID.

Keys for Customers

17 August 2017
Composable Commerce
HTTP API
Enhancement
Customers
Added key field to Customer
  • [API] Customers have a new optional field key that allows clients to specify a unique identifier for the customer. Keys can be set during creation of the customer or afterwards by the new update action Set Key. Now customers can also be retrieved, updated and deleted by key.

Customer Groups for Carts with no Customer assigned

15 August 2017
Composable Commerce
HTTP API
Enhancement
CustomersPricing and Discounts

We added the possibility to use customer group-specific price selection on carts with no customer assigned.

  • [API] CartDraft has a new optional field customerGroup that can be set if customerId is not present.
  • [API] Added new update action setCustomerGroup to set the customer group to a cart if customerId is not present.

OAuth 2.0 Token Introspection

3 August 2017
Composable Commerce
HTTP API
Enhancement
Security and privacy
We implemented OAuth 2.0 Token Introspection according to RFC 7662. It allows to determine the active state of an OAuth 2.0 access token and to determine meta-information about this access token, such as the scope.
  • [API] OAuth 2.0 Token Introspection is available on the auth service.
  • [API] The new introspect_oauth_tokens scope allows a client to introspect tokens issued to other clients.

Keys for Shipping Methods

26 July 2017
Composable Commerce
HTTP API
Enhancement
CartsOrders
Added key field to ShippingMethods
  • [API] ShippingMethods have a new optional field key that allows clients to specify a unique user-specified identifier for the shipping method. Keys can be set during creation of the shipping method or afterwards by the new update action Set Key.
    Now shipping methods can also be retrieved, updated and deleted by key.

Added key field on CustomerGroup

14 July 2017
Composable Commerce
HTTP API
Enhancement
Customers

We introduced a new 'key' field on CustomerGroup that can be used to identify a customer group by a user-defined ID in addition to the 'id' field.

Added possibility for product to be added to/removed from category by category key.

7 July 2017
Composable Commerce
HTTP API
Enhancement
Product catalog
After introducing keys on categories, we extended the update actions for adding and removing products to and from categories. Now it is possible to update products by category key in the same way as by category ID.

Added 'view' scopes to 'manage' scopes

29 June 2017
Composable Commerce
HTTP API
Enhancement
Security and privacy

Every 'manage' scope for a resource, like Product, Order, Customer, and so on, now also implies the respective 'view' scope automatically. Until now the 'view' scope had to be specified explicitly which is not needed anymore.

Added support for Azure Service Bus

28 June 2017
Composable Commerce
HTTP API
Enhancement
Messages/Subscriptions

We extended the number of supported message buses by adding the Azure Service Bus destination to the subscriptions endpoint.

Get customer by email token

26 June 2017
Composable Commerce
HTTP API
Enhancement
CustomersSecurity and privacy
For resetting a customer password it is now possible to get the customer by email token. For getting the customer by password token the new endpoint (/password-token={token}) should now be used in favor of the old query parameter (/?token={token}).

External Line Item Prices

21 June 2017
Composable Commerce
HTTP API
Enhancement
Pricing and Discounts

We introduced the new Line Item price mode 'ExternalPrice' in which the prices for line items are set externally while eligible cart discounts will be applied. The external prices can now be set during creation of line items.

Added update action to change Input Hint on Attribute Definition

20 June 2017
Composable Commerce
HTTP API
Enhancement
Product catalog
The inputHint on AttributeDefinition provides a hint to developers how text-based attribute values should be visually represented in the frontend. The two supported values for this field: SingleLine or MultiLine had to be set in the AttributeDefinitionDraft during creation of the attribute definition so far, but it can now be changed afterwards by introducing a new update action changing the value of this field.

Added salutation field on Customer

16 June 2017
Composable Commerce
HTTP API
Enhancement
CartsCustomers

Added a new optional field on customer resource to store information about the salutation of the customers. Added two new cart discount functions that help specify whether the given predicate should match for at least one or for all line items in the cart.

Tutorial Handling Subscriptions

15 June 2017
Composable Commerce
HTTP API
Enhancement
OrdersMessages/Subscriptions
We published a tutorial for Order Created Messages as an example for the scenario in which you want to send a notification via email to your customer when an order is created.

Product Deleted Message and more

14 June 2017
Composable Commerce
HTTP API
Enhancement
Product catalogMessages/Subscriptions

Added and changed messages about changes on products

Release note archive

2 June 2017
Composable Commerce
HTTP API
Announcement

The release notes published before 02 June 2017 are archived below.