Platform Release Notes

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.

We added the Message that is published by the platform when the Add OrderPayment update action is performed on Orders or OrderEdits. To subscribe to Messages, see Subscriptions for Messages and Notifications.

Change:

• [API] Added OrderPaymentAddedMessage.

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.

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 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 a 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.

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 LineItemReturnItemDraft and CustomLineItemReturnItemDraft.
• [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.

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 CustomType 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 field to the ProductProjection GraphQL type.

Change:

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

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 Revoking tokens.

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:

• [API] Introduced Order Search API in public beta.
• [API] Added orders field to Search Indexing Configuration on Projects.
• [API] Added Change Order Search Status update action on Projects.

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

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 CustomType 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

Previously, the Line Items in Carts and Orders contained the platform-assigned 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.

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 CustomType 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

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

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 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).

AWS EventBridge is now supported as a Subscription destination. Configuring EventBridge as a destination allows your serverless event bus to receive message from the commercetools platform 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 []

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.

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:

• [API] Added the view_key_value_documents:{projectKey} scope.
• [API] Added key-value-document to ChangeHistoryResourceType.
• [API] Added AddPropertyChange.
• [API] Added RemovePropertyChange.
• [API] Added SetPropertyChange.
• [API] Added SetValueChange.
• [API] Added CustomObjectLabel.
• [GraphQL API] Added the following types to the graphQL schema: CustomObjectLabel, CustomObjectChangeInput.
• [GraphQL API] Added queries customObject and customObjects.
• [GraphQL API] Added CustomObject to the ResourceType enum.

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:

• [API] Added CustomerFirstNameSetMessage.
• [API] Added CustomerLastNameSetMessage.
• [API] Added CustomerTitleSetMessage.
• [GraphQL API] Added the following types to the GraphQL schema: CustomerFirstNameSet, CustomerLastNameSet, CustomerTitleSet.

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 InventoryEntryQuantitySetMessage.
• [GraphQL API] Changed the InventoryEntryQuantitySet type:
  • Added the supplyChannelRef field to the InventoryEntryQuantitySet type.
  • Added the supplyChannel field to the InventoryEntryQuantitySet type.

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

We have added the ability to create a fixed price Cart Discount on a CustomLineItems target.

• [API] Added support for CustomLineItems Target when creating a fixed price Cart Discount.

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.

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.

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.

• [Graphql API] Added the error response format to the GraphQL API.

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.

• [API] Added existence check methods for Products by ID, by Key, and by Query Predicate.

It is now possible to sort on Custom Fields using custom.fields.${fieldName} sort parameter.

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.

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:

• Creating and managing Stores
• Custom fields on Stores
• Stores on Carts, Orders, Customers, and Shopping Lists
• Store-based OAuth scopes for orders, customers, and Shopping Lists
• Store-based Product Projection dimensions for filtering of locales, prices, and inventory based on Store settings.

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.

We have added a specific Message that is published by the platform whenever a Customer got 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 type.
• [GraphQL API] Added the following types to the GraphQL schema: CustomerDeleted.

It is now possible to exclude commercetools Platform initiated Changes from Audit Log response data sets.

Change:

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

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!

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 allows the platform to optimize the query towards short 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.

Calls to the introspection endpoint of an external OAuth server now include the correlation ID initially passed to the commercetools platform. This enables users to have a complete trace of the HTTP calls exchanged with the API and thus helps troubleshoot implementation issues.

We have set up a long-term support plan to actively support and maintain Version 1 SDKs until their end of life. Additionally, we have provided information about migration to our Version 2 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 Version 2 SDKs.

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, contact us via the Support Portal, specifying your project region, project key and your use case.

The limit of Subscriptions per Project has been raised from 25 to 50.

ProductProjection 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.

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

Changes:

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

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 us via the Support Portal.

• [API] Introduced an API Limit on Product Types.

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.

• [API] Added AddDiscountCodeChange.
• [API] Added RemoveDiscountCodeChange.
• [API] Added ChangeTaxCalculationModeChange.
• [API] Added ChangeTaxModeChange.
• [API] Added ChangeTaxRoundingModeChange.
• [API] Added SetCountryChange.
• [API] Added SetCustomLineItemTaxAmountChange.
• [API] Added SetCustomShippingMethodChange.
• [API] Added SetLineItemDistributionChannelChange.
• [API] Added SetLineItemTaxAmountChange.
• [API] Added SetOrderTotalTaxChange.
• [API] Added SetShippingMethodChange.
• [API] Added SetShippingMethodTaxAmountChange.
• [API] Added SetShippingMethodTaxRateChange.
• [API] Added SetShippingRateInputChange.
• [API] Added SetCustomLineItemTaxCategoryChange.
• [API] Added SetShippingInfoPriceChange.
• [API] Added SetShippingRateChange.
• [API] Added SetShippingInfoTaxedPriceChange.
• [API] Added SetOrderTaxedPriceChange.
• [API] Added SetCustomLineItemTaxRateChange.
• [API] Added SetLineItemTaxRateChange.
• [API] Added taxMode to SetOrderTaxedPriceChange.
• [API] Added taxMode to SetCustomLineItemTaxRateChange.
• [API] Added taxMode to SetLineItemTaxRateChange.
• [GraphQL API] Added the taxMode field to OrderChange.

The response to an OAuth 2.0 Token Introspection request now provides the client_id as optional field as defined in RFC 7662.

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.

• [API] Added the store field to ShoppingList, ShoppingListDraft, and MyShoppingListDraft.
• [API] Added new Store-related scopes, view_shopping_lists, manage_shopping_lists, and manage_my_shopping_lists
• [API] Added Get a ShoppingList in a Store by ID method to Shopping Lists and My Shopping Lists.
• [API] Added Get a ShoppingList in a Store by Key method to Shopping Lists and My Shopping Lists.
• [API] Added Query ShoppingLists in a Store method to Shopping Lists and My Shopping Lists.
• [API] Added Create a ShoppingList in a Store method to Shopping Lists and My Shopping Lists.
• [API] Added Update a ShoppingList in a Store by ID method to Shopping Lists and My Shopping Lists.
• [API] Added Update a ShoppingList in a Store by Key method to Shopping Lists and My Shopping Lists.
• [API] Added Set Store update action to Shopping Lists.
• [API] Added Delete a ShoppingList in a Store by ID method to Shopping Lists and My Shopping Lists.
• [API] Added Delete a ShoppingList in a Store by Key method to Shopping Lists and My Shopping Lists.
• [GraphQL API] The existing query fields inStore and inStores can be used to query, update and delete Shopping Lists in one or more Stores. The query fields can also be used for My Shopping Lists.
• [GraphQL API] Changed the ShoppingListQuery type:
  • Added the store field to the ShoppingListQuery type.

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:

• Product Projection Search
• Product Suggestions
• Project update with the action Change Product Search Indexing Enabled

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.

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, 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.

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.

For new 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:

• via API using the Change Product Search Indexing Enabled update action on the Project endpoint.
• Contact Support via the Support Portal and provide the region, project key(s), and use case(s).

Activation via the Merchant Center will be possible soon.

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.

• [API] Added searchIndexing field to Project.
• [API] Added Search Indexing Configuration for products to Project.
• [API] Added Search Indexing Configuration Values for status to Search Indexing Configuration.
• [API] Added Change Product Search Indexing Enabled update action to Project endpoint.
• [API] Added SearchDeactivated and SearchIndexingInProgress Errors.
• [GraphQL API] Added following types ChangeProjectSettingsProductSearchIndexingEnabled, SearchIndexingConfiguration, SearchIndexingConfigurationValues, SearchIndexingStatus.
• [GraphQL API] Added searchIndexing field to ProjectProjection type.
• [GraphQL API] Added input field changeProductSearchIndexingEnabled to ProjectSettingsUpdateAction type.

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 Prices of a ProductVariant.

• [API] The customerGroup field of PriceDraft now takes a value of type Resource Identifier, instead of a Reference, to a Customer Group.

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 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).

• [API] Added CartDiscountValue of type fixed that can be set on the CartDiscountValueDraft.
• [GraphQL API] Added the fixed field to the CartDiscountValueInput type.

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.

• [API] Added a custom field to the Address and AddressDraft.
• [API] Added Set Shipping Address Custom Type and Set Shipping Address Custom Field update actions for carts
• [API] Added Set Billing Address Custom Type and Set Billing Address Custom Field update actions for carts
• [API] Added Set Item Shipping Address Custom Type and Set Item Shipping Address Custom Field update actions for carts
• [API] Added Set Delivery Address Custom Type and Set Delivery Address Custom Field update actions for carts
• [API] Added Set Shipping Address Custom Type and Set Shipping Address Custom Field update actions for orders
• [API] Added Set Billing Address Custom Type and Set Billing Address Custom Field update actions for orders
• [API] Added Set Item Shipping Address Custom Type and Set Item Shipping Address Custom Field update actions for orders
• [API] Added Set Delivery Address Custom Type and Set Delivery Address Custom Field update actions for orders
• [API] Added Set Shipping Address Custom Type and Set Shipping Address Custom Field update actions for order edits
• [API] Added Set Billing Address Custom Type and Set Billing Address Custom Field update actions for order edits
• [API] Added Set Item Shipping Address Custom Type and Set Item Shipping Address Custom Field update actions for order edits
• [API] Added Set Delivery Address Custom Type and Set Delivery Address Custom Field update actions for order edits
• [API] Added Set Address Custom Type and Set Address Custom Field update actions on customers
• [API] Added Set Address Custom Type and Set Address Custom Field update actions on channels

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.

• [GraphQL API] Added support for Replicate a Cart in a Store endpoint.

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'.

• [API] Added shipping-method enumeration value to Customizable Resources.
• [API] Added custom field to ShippingMethodDraft and ShippingMethod.
• [API] Added the setCustomType update action to the Update ShippingMethod endpoint.
• [API] Added the setCustomField update action to the Update ShippingMethod endpoint.
• [GraphQL API] Added the custom field to the ShippingMethod type.
• [GraphQL API] Added setCustomType and setCustomFields to ShippingMethodUpdateAction type.

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 platform generated product.id and variant.id instead that differ between Projects.

• [API] Added variant.key field to Product Field Identifiers.
• [API] Added variant.key field to LineItem Field Identifiers.

It is now possible to identify an anonymous cart by using its id or external key. The previously used anonymousCartId will soon be deprecated.

• [API] Added anonymousCart field on customer authentication.
• [API] Added anonymousCart field on customer authentication in-store.
• [API] Added anonymousCart field on customer creation.
• [API] Added anonymousCart field on customer creation in-store customer.
• [API] Deprecated the anonymousCartId field in the listed endpoints above in favor of anonymousCart field.

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

• [API] Added CustomerPasswordUpdatedMessage.
• [API] Added Change Customer's Password in Store update action.

Merchants may now replicate any Cart or Order in a given Store to a new Cart bound to the same Store.

• [API] Added endpoint Replicate cart in store.

Additionally to identifying Carts by their platform-generated 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.

• [API] Added optional key field to Cart and CartDraft.
• [API] Added Get a Cart by Key method.
• [API] Added Update a Cart by Key method.
• [API] Added Delete a Cart by Key method.
• [API] Added Get a Cart in a Store by Key method.
• [API] Added Update a Cart in a Store by Key method.
• [API] Added Delete a Cart in a Store by Key method.
• [API] Added SetKey update action.
• [API] Added Replicate a Cart by Key method.
• [API] Added cart field to OrderFromCartDraft.
• [API] Deprecated the id field in OrderFromCartDraft in favor of the cart field.

We added the new field oldSlug to the CategorySlugChangedMessage and ProductSlugChangedMessage 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 CategorySlugChangedMessage.
• [API] Added optional field oldSlug to ProductSlugChangedMessage.
• [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.

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 commercetools Project change their passwords.

• [API] Added types customer-email-token and customer-password-token to the list of supported resourceTypeIds.

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

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.

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.

• [API] Added the error code ProjectNotConfiguredForLanguages.
• [API] Added the error code MissingRoleOnChannel.

We are moving the commercetools 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.

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.

When a resource is deleted with the dataErasure parameter set to true, the ResourceDeleted Payload will contain the dataErasure parameter as well to allow downstream systems to erase the data as well.

• [API] Added dataErasure to the ResourceDeleted Payload.

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.

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.

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.

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 Paging section of the "General Concepts" documentation for details and recommendations.

You can now add Custom Fields to Stores.

• [GraphQL API] Changed the Store type:
  • Added the custom field to the Store type.

When a query times out, the API now returns BadRequest with the QueryTimedOut error code instead of the General error code.

• [API] Added the QueryTimedOut error code.

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.

• [API] Added Language, Price, and InventoryEntry filtering.

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

• [API] Added ProductVariantAddedMessage.

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.

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.

You can now define custom fields on Stores.

This feature includes the following changes:

• [API] Added store enumeration value to Customizable Resources
• [API] Added custom field to StoreDraft and Store
• [API] Added the setCustomType update action to Update Store.
• [API] Added the setCustomField update action to Update Store.

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

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.

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.

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.

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

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

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.

• [API] Added ReferencedResourceNotFound error code

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.

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.

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.

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

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 LineItem 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.

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

Introduced new limits for new projects on the commercetools platform.

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, contact us via the Support Portal, specifying your project region, project key and your use case.

• [API] If your project contains more than the maximum allowed amount of Carts or Shopping Lists, the commercetools platform will automatically delete the resources that have been least recently modified.

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 Support via the Support Portal and provide the region, project key and use case.

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

Cart Predicate Functions like lineItemTotal are now taking the total prices for line items into account also when ExternalTotal LineItemPriceMode is used.

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.

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.

• [API] Added the changeCountryTaxRateFallbackEnabled update action to the project.

We now support getting, updating, and deleting My Shopping Lists by key.

• [API] Added get, update and delete "My Shopping Lists by Key" endpoints.

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.

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.

Up until now, the Image Search API required contact with our support team for activation. You can now facilitate user activation of the endpoint with the new ImageSearchConfig endpoint.

• [API] Added ImageSearchConfig endpoint.

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.

• [API] Customers Address selection and My Customer Profile Address selection have been added to be able to specify an address by key, so additional updates could be done along adding a new address.
• [API] Customers Change Address endpoint supports Address selection.
• [API] Customers Remove Address endpoint supports Address selection.
• [API] Customers Set Default Shipping Address endpoint supports Address selection.
• [API] Customers Add Shipping Address ID endpoint supports Address selection.
• [API] Customers Remove Shipping Address ID endpoint supports Address selection.
• [API] Customers Set Default Billing Address endpoint supports Address selection.
• [API] Customers Add Billing Address ID endpoint supports Address selection.
• [API] Customers Remove Billing Address ID endpoint supports Address selection.
• [API] My Customer Profile Change Address endpoint supports Address selection.
• [API] My Customer Profile Remove Address endpoint supports Address selection.
• [API] My Customer Profile Set Default Shipping Address endpoint supports Address selection.
• [API] My Customer Profile Add Shipping Address ID endpoint supports Address selection.
• [API] My Customer Profile Remove Shipping Address ID endpoint supports Address selection.
• [API] My Customer Profile Set Default Billing Address endpoint supports Address selection.
• [API] My Customer Profile Add Billing Address ID endpoint supports Address selection.
• [API] My Customer Profile Remove Billing Address ID endpoint supports Address selection.

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.

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.

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

The commercetools platform 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 API here. Log in here.

Machine Learning APIs are not available on Google Cloud Sydney.

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.

• [API] Changed the Get ShippingMethods for a Location endpoint.
• [API] Changed the Get ShippingMethods for an OrderEdit endpoint.
• [API] Deprecated the query parameter ?country={country} on /shipping-methods endpoints.
• [API] Deprecated the query parameter ?orderEditId={orderEditId} on /shipping-methods endpoints.

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.

• [API] Added InventoryEntryCreatedMessage.

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

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.

• [API] Stores can have languages configured. Only languages defined in the project can be used in stores.
  • added languages to Store.
  • added languages to StoreDraft.
  • added update action setLanguages on Store.
• [API] Added query parameter localeProjection on Product Projections for locale-based projections without Store. This parameter can be used on Get ProductProjection by ID, Get ProductProjection by Key, Query ProductProjections and Search ProductProjections.
• [API] Added query parameter storeProjection on Product Projections for locale-based projections with Store. This parameter can be used on Get ProductProjection by ID, Get ProductProjection by Key, Query ProductProjections and Search ProductProjections.
• [API] If a Cart is bound to a Store, all LocalizedStrings are filtered according to the locales defined in the store.

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.

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).

• [API] Added the SetStore update action
• [API] Added the OrderStoreSetMessage

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

• [API] Added the localizedDescription attribute to the ShippingMethod and ShippingMethodDraft representations.
• [API] Added setLocalizedDescription action.
• [API] The attribute description as well as the action setDescription has been deprecated.

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.

• [API] Added the following methods to the HTTP API to access States:
  • Get a State by Key
  • Update State by Key
  • Delete State by Key

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.

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.

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.

• [API] Changed the Get ShippingMethods for a Cart endpoint.
• [API] Changed the Get ShippingMethods for a Cart in a Store by ID endpoint.
• [API] Deprecated the query parameter ?cartId={id} on /shipping-methods endpoints.

The commercetools platform 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.

Machine Learning APIs are not available on the AWS 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

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.

• [API] Changed the Get a Cart by Customer ID endpoint.
• [API] Changed the Get a Cart in a Store by Customer ID endpoint.
• [API] Deprecated the query parameter ?customerId={id} on /carts endpoints.

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.

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.

• [API] Added the CartsConfiguration and ShoppingListsConfiguration to the project.
• [API] Added the changeCartsConfiguration and changeShoppingListsConfiguration update actions to the project.

• [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.

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).

• [API] Added the CloudEvents 1.0 Format to the Subscriptions API.
• [API] New Delivery Payload for the CloudEvents Format in accordance to the 1.0 version of the specification.

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.

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.

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.

• [API] Added an endpoint to Get ShippingMethods for a Cart in a Store by ID
• [GraphQL API] The existing query fields inStore and inStores now contain the field shippingMethodsByCart

We have now increased the maximum allowed value for the product set limit in the MissingAttributesSearchRequest of the Missing Data API from 10.000 to 100.000 and made this the new default value.

• [API] Increased default value of the productSetLimit to 100000.

Category Recommendations API is not activated by default for all production projects anymore. The API needs to be manually activated through the Merchant Center. Instructions can be found here.

• [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.

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.

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:
  • Get Customer in a Store
  • Create Customer (Sign Up) in a Store
  • Authenticate Customer (Sign In) in a Store
  • Update Customer in a Store
  • Change Customer's Password in a Store
  • Reset Customer's Password in a Store
  • Verify Customer's Email in a Store
  • Delete Customer in a 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}.

• [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.

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.

You can now assign an order to a Store when using the Order Import API.

• [API] Added the store field to the OrderImportDraft

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

• [API] Added the view_published_products:{projectKey} OAuth scope
• [API] Added the view_published_products:{projectKey} OAuth scope to the following endpoints:
  • fetch a product projection by ID
  • fetch a product projection by Key
  • query product projections
  • search for product projections
  • use suggestions

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.

• [API] New store-based OAuth scopes manage_customers:{projectKey}:{storeKey} and view_customers:{projectKey}:{storeKey}.
• [API] Added the following methods to the HTTP API to access Customer in a specific Store:
  • Get a Customer in a Store by ID
  • Get a Customer in a Store by Key
  • Query Customer in a Store
  • Create Customer (Sign Up) in a Store
  • Update Customer in a Store by ID
  • Update Customer in a Store by Key
  • Set Stores
  • Add Store
  • Remove Store
  • Authenticate Customer (Sign In) in a Store
  • Create a Token for Resetting the Customer’s Password in a Store
  • Get Customer By Password Token in a Store
  • Reset Customer’s Password in a Store
  • Create a Token for verifying the Customer’s Email in a Store
  • Get Customer By Email Token in a Store
  • Verify Customer’s Email in a Store
  • Delete Customer by ID in a Store
  • Delete Customer by Key in a Store
• [API] Added the OAuth 2.0 Password Flow for Customer in a Store.
• [GraphQL API] Added the stores fields on the types Customer, CustomerDraft.
• [GraphQL API] The existing query fields inStore and inStores can be used to query customers.
• [GraphQL API] Added the storeKey argument to customer mutations customerSignUp, updateCustomer, deleteCustomer, customerChangePassword, customerCreatePasswordResetToken, customerResetPassword, customerCreateEmailVerificationToken, customerConfirmEmail

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

The new Machine Learning API can queries a product catalog using an image. The endpoint returns images which are similar to the query image and the product variants they are associated with. This is a beta feature. For more information, see Beta Features.

A technical blog post about how the feature works can be read here.

The quality of predictions is highest when the product in the image is aligned centrally, with a noiseless background, and is taken in a similar style to that of images in the product database. The model has been benchmarked using fashion datasets, and so is optimized towards these kind of queries.

In the future, the Machine Learning team will develop these models further for more generalized accuracy.

• [API] Added public endpoints for the Image Search feature.

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:

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:

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

The commercetools platform now emits messages when adding and removing a product from a category.

• [API] Added the ProductAddedToCategoryMessage to Product's Add to Category update action.
• [API] Added the ProductRemovedFromCategoryMessage to Product's Remove from Category update action.

You can now use a Customer's key field in Cart Discount Predicates.

• [API] Added customer.key to Customer Field Identifiers in Cart Predicates

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.

• [API] Added the following methods the HTTP API to access Carts in a specific Store:
  • Get a Cart in a Store by ID
  • Get a Cart in a Store by Customer ID
  • Query Carts in a Store
  • Create a Cart in a Store
  • Update a Cart in a Store
  • Delete a Cart in a Store
• [API] Added the following methods the HTTP API to access My Carts in a specific Store:
  • Get a Cart in a Store by ID
  • Get Active Cart in a Store by ID
  • Query Carts in a Store
  • Create a Cart in a Store
  • Update a Cart in a Store
  • Delete a Cart in a Store
• [API] Added the following methods the HTTP API to access Orders for Stores:
  • Get Order in a Store by ID
  • Get Order in a Store by OrderNumber
  • Query Orders in a Store
  • Create Order from Cart in a Store
  • Update Order in a Store by ID
  • Update Order in a Store by OrderNumber
  • Delete Order in a Store by ID
  • Delete Order in a Store by OrderNumber
• [API] Added the following methods the HTTP API to access My Orders for Stores:
  • Get Order in a Store by ID
  • Query Orders in a Store by ID
  • Create Order in a Store from a Cart
• [API] New store-based OAuth scopes manage_my_orders:{projectKey}:{storeKey}.

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

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.

• [API] Added the ChangeInputHint update action
• [API] Added the ChangeEnumValueLabel update action
• [API] Added the ChangeLocalizedEnumValueLabel update action

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

The deleteDaysAfterLastModification field has been taken out of Beta. The field's current functionality has not changed.

• [API] Took the deleteDaysAfterLastModification out of Beta on the following representations:
  • Cart, CartDraft, MyCartDraft,ShoppingList, ShoppingListDraft, MyShoppingListDraft

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 platform 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 to commercetools using the X-External-User-ID header. See Client Logging for more information.

• [API] Added the lastModifiedBy and createdBy fields to the following representations:

  • Cart
  • CartDiscount
  • Category
  • Channel
  • Customer
  • CustomerGroup
  • DiscountCode
  • Extension
  • InventoryEntry
  • Payment
  • Product
  • ProductDiscount
  • ProductType
  • Order
  • OrderEdit
  • TaxCategory
  • Type
  • Review
  • State
  • ShoppingList
  • Subscription

• [API] Added support for the X-External-User-ID HTTP header.

• [Docs] Created Client Logging documentation.

• [Docs] Refactored Discount Predicate and Discount Predicate Field Identifiers documentation.

• [Docs] Created Discounts Overview and Product Discounts documentation.

• [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

Change how to calculate the maximum allowed limit for product comparisons in Similar Products. The maximum limit for product comparisons is now calculated using the number of comparisons between the two specified ProductSetSelectors instead of a fixed limit for each ProductSetSelector.

This ensures a single product can be compared to the whole product catalog even for large product catalogs ranging up to 20,000,000 products.

• [API] Changed the calculation of the maximum allowed limit for product comparisons in the Similar Products API.

To improve platform security, On 6 May 2019 the commercetools platform API endpoints will no longer accept access tokens as URI parameters.

All API Clients should provide access tokens to the commercetools platform API using the Authorization header as follows:

For more information, see:

• OAuth 2.0 Specification – RFC 6750, §2.3
• Authorization
• Using an access token

Renamed the Similar Products's ProductSelector representation to ProductSetSelector to better reflect its functionality. For more information, see Beta features.

• [API] Renamed ProductSelector to ProductSetSelector in the Similar Products API.

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.

• [Doc] Documented Reference expansion on GraphQL.
• [Doc] Documented Extension error responses.

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] Added the ExternalOAuth configuration to the project.
• [API] Added the setExternalOAuth update action.
• [API] Added customer_id:{id} and anonymous_id:{id} to the OAuth scope.

The maximum time the commercetools platform 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 Support via the Support Portal and provide the region, project key and use case.

• [API] Added timeoutInMs to Extension and ExtensionDraft.
• [API] Added the setTimeoutInMs update action.

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.

• [API] Added discounted field to PriceDraft.

Released Missing Data API, which allows users to scan the product catalog for products that have missing attributes, prices, or images. This can be used to detect incomplete product data and increase the data quality in a project.

• [API] Added public endpoints for the Missing Data API feature.

The default value of the limit field in the Similar Products API search request is now 20. The maximum allowed value is now 500 for consistency with the rest of the commercetools HTTP API.

• [API] Changed the default value and value range of limit in the Similar Products API update action.

Introduced new limits for new projects on the commercetools platform 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, contact us via the Support Portal, specifying your project region, project key and your use case.

• [API] Introduced new API Limits.

The Similar Products API now uses the currencyCode field for consistency with the rest of the commercetools HTTP API.

• [API] Added the currencyCode field to the Similar Products API update action. This replaces the currency field.

You can now use Cart and Orders as ReferenceTypes when creating a Custom Type.

• [API] Added the cart and order fields to ReferenceType.

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".

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.

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.

The Add ProductVariant update action now includes an assets field for providing images when creating a Product Variant.

• [API] Added the assets field to the Add ProductVariant update action.

For carts with taxMode External, it is now possible to set includedInPrice to either true or false in the ExternalTaxRateDraft.

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.

You can now reference a Channel using a user-defined key field in the following scenarios:

• When importing a LineItem of an Order using the Order Import API.

• When updating the synchronization information of an Order.

• When creating a Product, setting a Product's price, or Adding or Changing Prices of a ProductVariant.

• [API] the following fields are now a ResourceIdentifier to a Channel instead of a Reference:

  • LineItemDraft on Carts:
    • supplyChannel
    • distributionChannel
  • MyLineItemDraft and Add LineItem on MyCarts:
    • supplyChannel
    • distributionChannel
  • LineItemImportDraft on Order Import:
    • supplyChannel
    • distributionChannel
  • PriceDraft on Products:
    • channel
  • Update SyncInfo on Orders:
    • channel

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 the new ShippingInfoImportDraft representation. This representation improves the Order Import API by importing more robust shipping information.

In addtion, you can now reference the following fields by their key, instead of just their id value when performing a set or update action:

• Channel on an InventoryEntry
• ShippingMethod on a Cart and Order
• TaxCategory on a Product, Cart, and Order

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

• [API] Introduced the ShippingInfoImportDraft representation. ShippingInfoImportDraft is a new type that contains the following backwards compatible changes:
  • The taxCategory field on ShippingInfoImportDraft is a ResourceIdentifier to a TaxCategory.
  • The shippingMethod field on ShippingInfoImportDraft is a ResourceIdentifier to a ShippingMethod.
• [API] Order Import - The shippingInfo field on OrderImportDraft is now a ShippingInfoImportDraft instead of a ShippingInfo.
• [API] The supplyChannel fields on InventoryEntryDraft and on the Set SupplyChannel update action are now a ResourceIdentifier to a Channel instead of a Reference.
• [API] The following shippingMethod fields are now a ResourceIdentifier to a ShippingMethod instead of a Reference:
  • Carts:
    • on CartDraft
    • on the Set ShippingMethod update action
  • Order Edits:
    • on the Set ShippingMethod update action
    • on the Set ShippingAddressAndShippingMethod update action
• [API] The following taxCategory fields are now a ResourceIdentifier to a TaxCategory instead of a Reference:
  • Products:
    • on ProductDraft
    • on the Set TaxCategory update action
  • Carts:
    • on CustomLineItemDraft
    • on the Add CustomLineItem update action
    • on the Set CustomShippingMethod update action
  • Order Edits:
    • on the Set ShippingAddressAndCustomShippingMethod update action
    • on the Set CustomShippingMethod update action
    • on the Add CustomLineItem update action

• [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)

Released Similar Products Machine Learning API, which allows users to search for similar products in a product catalog. You can use this feature to detect and clean up product duplicates.

• [API] Added endpoints for the Similar Products feature.

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

It is now possible to retrieve category assets via GraphQL API category search and category auto completion.

Shipping Zones now have a user defined key attribute. The key attribute is used when creating or updating a ShippingMethod to identify a Zone.

• [API] Added the key attribute on the Zone and ZoneDraft representations.
• [API] You can now get, update, and delete a Shipping Zone by its key.
• [API] When creating a ShippingMethod, the Shipping Zone can be referenced by its ID or its key.
• [API] addShippingRate, removeShippingRate, addZone, and removeZone, can now reference a zone by its ID or its Key.

It is now possible to handle returns for goods that were ordered as CustomLineItems.

• [API] Renamed ReturnItem to LineItemReturnItem.
• [API] Renamed ReturnItemDraft to LineItemReturnItemDraft.
• [API] Added CustomLineItemReturnItemDraft and CustomLineItemReturnItem to be used on a ReturnInfo.

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.

Introduced Machine Learning APIs to autonomously learn from data and make automated predictions. This reduces the amount of manual work required to manage projects.

The first machine learning API endpoint available is the Category Recommendations endpoint. The Category Recommendations endpoint suggests categories that best fit a given product. Further information on the background of this feature can be found on the tech blog.

• [API] Added public endpoints for the Category Recommendations feature.

It is now possible to set or update the TaxCategory on a ShippingMethod by its id or by its Key.

• [API] The taxCategory fields on ShippingMethodDraft and on the update action "changeTaxCategory" are now a ResourceIdentifier to a TaxCategory. (They were a Reference before)

We introduced new Messages that are emitted when the DiscountedPrice on a ProductVariant has changed.

• [API] Added ProductPriceDiscountsSetMessage.
• [API] Added ProductPriceExternalDiscountSetMessage.

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

• [API] Added score sorting criteria in ProductProjection Search API.

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.

• [API] new field dryRun at OrderEditDraft, update OrderEdit by ID and update OrderEdit by key

We now documented the parameter to set the life span of the token that is generated for resetting the password of a Customer.

• [Documentation] Added field ttlMinutes to the documentation for API method Create a Token for Resetting the Customer’s Password.

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).

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

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.

• [API] The new manage_project_settings scope grants access to modifying and viewing the project settings. Previously, only the manage_project scope did.

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.

• [API] Added update action SetLineItemPrice.
• [API] Added field refusedGifts to Order.
• [API] Added message OrderCustomerGroupSetMessage.

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.

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.

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.

• [API] Added resourceUserProvidedIdentifiers to the common message fields
• [API] Added resourceUserProvidedIdentifiers to the subscription payload

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

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

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.

The OrderEdit tutorial shows some examples how edits can be performed.

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

• [API] New types OrderEdit, OrderEditDraft, StagedOrderUpdateAction, OrderEditResult, OrderExcerpt and OrderMessagePayload
• [API] New OrderEdit endpoint with functionality to create, update by ID, update by key, query, get by ID, get by key, apply, delete by ID and delete by key.
• [API] New OrderUpdateActions which only be performed via OrderEdits: setCountry, setShippingMethod, setCustomShippingMethod, addDiscountCode, removeDiscountCode, setCustomerGroup, setShippingMethodTaxRate, setShippingMethodTaxAmount, setOrderTotalTax, changeTaxMode, changeTaxRoundingMode, setShippingRateInput, changeTaxCalculationMode, addShoppingList, setShippingAddressAndShippingMethod, setShippingAddressAndCustomShippingMethod, addLineItem, removeLineItem, changeLineItemQuantity, setLineItemTaxRate, setLineItemTaxAmount, setLineItemTotalPrice, addCustomLineItem, removeCustomLineItem, setCustomLineItemTaxAmount, setCustomLineItemTaxRate, changeCustomLineItemQuantity, changeCustomLineItemMoney
• [API] New error code EditPreviewFailed
• [API] New Scopes manage_order_edits:{projectKey} and view_order_edits:{projectKey}
• [API] Get ShippingMethods for an OrderEdit

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).

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.

• MatchingPriceNotFound for Orders and Carts
• MissingTaxRateForCountry for Orders, Carts and Customers
• DuplicateFieldWithConflictingResource for Zones
• DuplicateField for TaxCategories

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

• DiscountCodeNonApplicable for Orders and Carts

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

• [API] Added the EnumValueIsUsed error code.

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.

• [API] Added update action Set Valid From and Until.
• [API] Added update action Set Valid From and Until.
• [GraphQL API] Added CartDiscountUpdateAction.setValidFromAndUntil.
• [GraphQL API] Added DiscountCodeUpdateAction.setValidFromAndUntil.

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

• [API] Added OrderDeletedMessage.

We have extended the support for Reference Expansion to ShippingMethod-related endpoints.

• [API] Added expand parameter to Get ShippingMethods for a Cart.
• [API] Added expand parameter to Get ShippingMethods for a Location.

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:

  • Add missing field roles used in the Reviews tutorial.

• [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

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 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 to set 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.

• [API] Added the SubscriptionHealthStatus, and a new field status to the subscription.
• [API] Added the new update action changeDestination
• [API] Added a public endpoint to monitor the health of a subscription

The product discount limit was increased to 500.

• [API] Increased limit on ProductDiscount to 500

Both Subscriptions and API Extensions can contain access secrets, for example to allow the commercetools platform to place a message into a queue, or to invoke an AWS Lambda function. When retrieving an access secret via the commercetools platform 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.

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.

• [API] Added update action SetCustomerId on Order.
• [API] Added message OrderCustomerSetMessage.

• [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

Added setValidFromAndUntil to product discount update methods.

• [API] Added update action Set Valid From and Until to ProductDiscount
• [GraphQL API] Added ProductDiscountUpdateAction.setValidFromAndUntil

The Change Subscription payloads now have the field modifiedAt.

• [API] The Payloads ResourceCreated, ResourceUpdated and ResourceDeleted have a new field modifiedAt.

• [API] orderState and state can now be set in the OrderFromCartDraft

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).

• [API] The Google Cloud Pub/Sub destination has been added.

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 native 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.