Archive of deprecated and removed API functionalities.
For each deprecated functionality, we provide information about the alternative functionality (if available) and the date of deprecation. We link to the deprecation announcement and (if applicable) to the announcement when the functionality was removed.
HTTP API
Business Units
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
| AssociateRole type and enum | Associate Roles API | Deprecated on 2 May 2023, and removed on 2 August 2023. |
roles field on Associate and AssociateDraft | associateRoleAssignments field on Associate and AssociateDraft | Deprecated on 2 May 2023, and removed on 2 August 2023. |
Carts
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
?customerId={id} query parameter | Added dedicated by Customer ID endpoints. | Deprecated on 27 January 2020. |
discountedPrice field in LineItem, LineItemDraft, CustomLineItem, and CustomLineItemDraft | discountedPricePerQuantity field in LineItem, LineItemDraft, CustomLineItem, and CustomLineItemDraft | Deprecated on 12 October 2015. |
Cart Discounts
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
excludeCount field in CountOnLineItemUnits and CountOnCustomLineItemUnits | Handled by triggerPattern field. | Deprecated on 6 March 2025. |
originalPrice Line Item predicate field | Use price Line Item predicate field. | Deprecated and removed on 27 September 2017. |
Change History
The following Change Types have been deprecated on 23 October 2025.
AddAssociateChange
This Change is no longer triggered by the Add Associate update action.
It has been deprecated and replaced by the SetAssociatesChange.
typeString | "AddAssociateChange" |
changeString | "addAssociate" |
nextValueAssociate | Value after the change. |
AddPriceChange
This Change is no longer triggered by the Add Price update action.
It has been deprecated and replaced by the SetPricesChange.
typeString | "AddPriceChange" |
changeString | "addPrice" |
nextValuePrice | Value after the change. |
catalogDataString | Product data that was updated.
|
priceIdString | id of the Embedded Price. |
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
AddProductSelectionChange
This Change is no longer triggered by the Add Product Selection update action.
It has been deprecated and replaced by the SetProductSelectionsChange.
typeString | "AddProductSelectionChange" |
changeString | "addProductSelection" |
previousValueProductSelectionSetting | |
nextValueProductSelectionSetting |
AddStateRolesChange
This Change is no longer triggered by the Add State roles update action.
It has been deprecated and replaced by the SetStateRolesChange.
typeString | "AddStateRolesChange" |
changeString | "addRoles" |
previousValueArray of StateRoleEnum | Value before the change. |
nextValueArray of StateRoleEnum | Value after the change. |
RemoveAssociateChange
This Change is no longer triggered by the Remove Associate update action.
It has been deprecated and replaced by the SetAssociatesChange.
typeString | "RemoveAssociateChange" |
changeString | "removeAssociate" |
previousValueAssociate | Value before the change. |
RemovePriceChange
This Change is no longer triggered by the Remove Embedded Price update action.
It has been deprecated and replaced by the SetPricesChange.
typeString | "RemovePriceChange" |
changeString | "removePrice" |
previousValuePrice | Value before the change. |
nextValuePrice | Value after the change. |
catalogDataString | Product data that was updated.
|
priceIdString | id of the Embedded Price. |
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
RemoveProductSelectionChange
This Change is no longer triggered by the Remove Product Selection update action.
It has been deprecated and replaced by the SetProductSelectionsChange.
typeString | "RemoveProductSelectionChange" |
changeString | "removeProductSelection" |
previousValueProductSelectionSetting | Value before the change. |
RemoveStateRolesChange
This Change is no longer triggered by the Remove State roles update action.
It has been deprecated and replaced by the SetStateRolesChange.
typeString | "RemoveStateRolesChange" |
changeString | "removeRoles" |
previousValueArray of StateRoleEnum | Value before the change. |
nextValueArray of StateRoleEnum | Value after the change. |
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
SetNameChange for name changes on Discount Codes, States, and Stores. | SetLocalizedNameChange | Deprecation announced on 18 July 2023, and change performed on 18 October 2023. |
Customers
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
| Change Name update action | Set First Name, Set Last Name, Set Middle Name, and Set Title update actions | Deprecated on 15 January 2016. |
anonymousCartId field in CustomerDraft and CustomerSignIn | anonymousCart field in CustomerDraft and CustomerSignin | Deprecated on 12 January 2021. |
Custom Fields
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
typeId and typeKey fields in CustomFields and CustomFieldsDraft | type field in CustomFields and CustomFieldsDraft | Deprecated on 15 January 2016. |
Custom Objects
Query CustomObjects
Deprecation announced on 16 September 2020.
GET
https://api.{region}.commercetools.com/{projectKey}/custom-objects
For performance reasons, it is highly advisable to query for Custom Objects in a container by using the
container field in the where predicate.This endpoint is deprecated and replaced by the Query CustomObjects in Container endpoint.
OAuth 2.0 Scopes:
view_products:{projectKey}view_orders:{projectKey}view_customers:{projectKey}view_key_value_documents:{projectKey}Path parameters:
projectKeyString | key of the Project. |
regionString | Region in which the Project is hosted. |
Query parameters:
expandExpansion | The parameter can be passed multiple times. |
sortSort | The parameter can be passed multiple times. |
limitInt | Number of results requested. Default: 20Minimum: 0Maximum: 500 |
offsetInt | Number of elements skipped. Default: 0Maximum: 10000 |
withTotalBoolean | Controls the calculation of the total number of query results. Set to false to improve query performance when the total is not needed.Default: true |
whereQueryPredicate | The parameter can be passed multiple times. |
var.<varName>String | Predicate parameter values. The parameter can be passed multiple times. |
Response:
200
CustomObjectPagedQueryResponse
asapplication/jsoncurl --get https://api.{region}.commercetools.com/{projectKey}/custom-objects -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" {
"limit": 20,
"offset": 0,
"count": 2,
"total": 2,
"results": [
{
"id": "f584ebbb-3805-43f3-80c8-76f98b2c18b5",
"version": 5,
"container": "test-container",
"key": "ac390383-370f-43f8-a534-db1604cb96a8",
"value": {
"name": "commercetools",
"slug": "commercetools",
"geoLocation": {
"type": "Point",
"coordinates": [13.412119019109015, 52.50103330534661]
}
},
"createdAt": "2015-05-28T09:48:35.098Z",
"lastModifiedAt": "2015-07-01T15:58:36.930Z"
},
{
"id": "d8523d32-a79d-441c-90f4-744cc342126e",
"version": 2,
"container": "test-container",
"key": "test-key",
"value": "test-value",
"createdAt": "2016-02-18T10:36:29.468Z",
"lastModifiedAt": "2016-02-18T10:36:29.571Z"
}
]
}| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
| Get CustomObject by ID endpoint | Get CustomObject by container and key | Deprecated and removed on 16 September 2020. |
| Delete CustomObject by ID endpoint | Delete CustomObject by container and key | Deprecated and removed on 16 September 2020. |
Host names
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
api.sphere.io, api.commercetools.com (Google Cloud, Belgium) and api.commercetools.co (Google Cloud, Iowa) | api.europe-west1.gcp.commercetools.com (Google Cloud, Belgium) and api.us-central1.gcp.commercetools.com (Google Cloud, Iowa) | Deprecated on 3 February 2020. |
Import API
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
publish field in EmbeddedPriceImport and ProductVariantImport | staged field in EmbeddedPriceImport and ProductVariantImport | Deprecated on 24 April 2024, and removed on 1 August 2024. |
key field in OrderImport | orderNumber field in OrderImport | Deprecated and removed on 23 April 2021. |
| Import Sink | Import Container | Deprecated on 30 August 2021, and replaced on 30 November 2021. |
Messages
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
paymentId field in PaymentStatusInterfaceCodeSetMessage | id field in PaymentStatusInterfaceCodeSetMessage | Deprecated on 29 September 2017. |
Payments
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
"AUTHORIZATION" and "CHARGE" fields in TransactionType | "Authorization" and "Charge" fields in TransactionType | Deprecated and replaced on 29 September 2017. |
externalId field in Payment and PaymentDraft | key field in Payment and PaymentDraft | Deprecated and removed on 29 September 2017. |
amountAuthorized, amountPaid, and amountRefunded fields in Payment and PaymentDraft | Values can be calculated from the total amounts saved in the Transactions. | Deprecated and removed on 29 September 2017. |
authorizedUntil field in Payment and PaymentDraft | Value is either not reliably known, or the authorization time is fixed for a PSP. | Deprecated and removed on 29 September 2017. |
| Set ExternalId, Set Authorization, Set AmountRefunded, and Set AmountPaid update actions | None | Deprecated and removed on 29 September 2017. |
Products
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
setSKU update action (without staged field) | Set SKU update action | Deprecated on 30 March 2016. |
price, sku, and variantId fields in Remove Price update action | priceId field in Remove Price | Deprecated on 17 May 2023, and removed on 15 June 2023. |
Product Selections
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
| ProductVariantSelectionInclusion and ProductVariantSelectionExclusion types | ProductVariantSelection IncludeOnly, ProductVariantSelection IncludeAllExcept, ProductVariantExclusion | Deprecated on 6 March 2023, and migrated automatically on 30 June 2023. |
ProductSelectionType (Individual and IndividualExclusion) | ProductSelectionMode (Individual and IndividualExclusion) | Deprecated on 18 April 2023, and removed on 4 August 2023. |
type field in ProductSelection and ProductSelectionDraft | mode field in ProductSelection and ProductSelectionDraft | Deprecated on 18 April 2023, and removed on 4 August 2023. |
Product Type
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
| Change Attribute Order update action | Change the order of AttributeDefinitions update action | Deprecated on 21 January 2019. |
Project
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
| Change Messages Enabled update action | Change Messages Configuration update action | Deprecated on 8 October 2018. |
Order
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
id field on OrderFromCartDraft | cart field on OrderFromCartDraft | Deprecated on 22 December 2020. |
lastMessageSequenceNumber field in Order | Do not use in applications. | Deprecated on 24 May 2022. |
Shipping Methods
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
?cartId={id} query parameter | Use Get matching ShippingMethods for a Cart or for a Cart in Store endpoint. | Deprecated on 6 February 2020. |
?country={country} and ?orderEditId={orderEditId} query parameters | Use Get matching ShippingMethods for a Location and for an OrderEdit endpoints. | Deprecated and removed on 24 March 2020. |
description field in ShippingMethod and ShippingMethodDraft | localizedDescription in ShippingMethod and ShippingMethodDraft | Deprecated on 3 March 2020. |
| Set Description update action | Set Localized Description update action | Deprecated on 3 March 2020. |
Subscriptions
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
| IronMQ Subscription destination | Use other destinations. | Deprecated on 9 August 2018, and removed on 12 January 2023. |
| CloudEvents version 0.1 | Use CloudEvents version 1.0. | Deprecated and replaced on 23 December 2019. |
GraphQL API
Fields
Asset
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
customFieldsRaw, customFields, and customFieldList | custom.customFieldsRaw | Deprecated on 20 August 2019. |
Associate
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
roles | associateRoleAssignments | Deprecated on 2 May 2023, and removed on 2 August 2023. |
| SimpleAssociateRole type | AssociateRole | Deprecated on 2 May 2023, and removed on 2 August 2023. |
Category
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
customFieldsRaw, customFields, and customFieldList | custom.customFieldsRaw | Deprecated on 20 August 2019. |
productCount | stagedProductCount | Deprecated on 6 August 2018, and removed on 14 June 2021. |
Cart
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
customFieldsRaw, customFields, customFieldList | custom.customFieldsRaw | Deprecated on 20 August 2019. |
CartDiscount
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
customFieldsRaw, customFields, customFieldList | custom.customFieldsRaw | Deprecated on 20 August 2019. |
CartDiscountValueBaseMoneyInput
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
currencyCode, centAmount | Use centPrecision or highPrecision. | Deprecated on 31 July 2023. |
Channel
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
typeId | channelRef | Deprecated on 17 January 2020. |
customFieldsRaw, customFields, customFieldList | custom.customFieldsRaw | Deprecated on 20 August 2019. |
CountOnCustomLineItemUnits
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
excludeCount | CartDiscountPatternTarget.triggerPattern | Deprecated on 6 March 2025. |
CountOnCustomLineItemUnitsInput
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
excludeCount | CartDiscountPatternTargetInput.triggerPattern | Deprecated on 6 March 2025. |
CountOnLineItemUnits
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
excludeCount | CartDiscountPatternTarget.triggerPattern | Deprecated on 6 March 2025. |
CountOnLineItemUnitsInput
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
excludeCount | CartDiscountPatternTargetInput.triggerPattern | Deprecated on 6 March 2025. |
Customer
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
customFieldsRaw, customFields, customFieldList | custom.customFieldsRaw | Deprecated on 20 August 2019. |
CustomerGroup
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
customFieldsRaw, customFields, customFieldList | custom.customFieldsRaw | Deprecated on 20 August 2019. |
typeId | customerGroupRef | Deprecated on 17 January 2020. |
CustomFieldsCommand
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
type | typeResId | Deprecated on 27 August 2020. |
CustomFieldsType
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
customFields | custom.customFieldsRaw | Deprecated on 20 August 2019. |
CustomLineItem
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
customFieldsRaw, customFields, customFieldList | custom.customFieldsRaw | Deprecated on 20 August 2019. |
CustomLineItemDraftOutput
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
taxCategory | taxCategoryResId | Deprecated on 27 August 2020. |
DiscountCode
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
customFieldsRaw, customFields, customFieldList | custom.customFieldsRaw | Deprecated on 20 August 2019. |
Initiator
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
customer, user | customerRef, userRef | Deprecated on 27 August 2020. |
InventoryEntry
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
customFieldsRaw, customFields, customFieldList | custom.customFieldsRaw | Deprecated on 20 August 2019. |
LineItem
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
customFieldsRaw, customFields, customFieldList | custom.customFieldsRaw | Deprecated on 20 August 2019. |
LineItemDraftOutput
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
distributionChannel, supplyChannel | distributionChannelResId, supplyChannelResId | Deprecated on 27 August 2020. |
NestedAttributeDefinitionType
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
typeReference | typeRef | Deprecated on 27 August 2020. |
Order
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
customFieldsRaw, customFields, customFieldList | custom.customFieldsRaw | Deprecated on 20 August 2019. |
Payment
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
amountAuthorized, authorizedUntil, amountPaid, amountRefunded | None | Deprecated on 29 September 2017. |
customFieldsRaw, customFields, customFieldList | custom.customFieldsRaw | Deprecated on 20 August 2019. |
ProductPrice
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
customFieldsRaw, customFields, customFieldList | custom.customFieldsRaw | Deprecated on 20 August 2019. |
RemoveProductPrice
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
variantId, sku, price | priceId | Deprecated on 17 May 2023, and removed on 15 June 2023. |
ProductProjectionMessagePayload
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
masterData | masterVariant | Deprecated and replaced on 15 February 2021 |
productProjectionSearch
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
markMatchingVariant argument | markMatchingVariants | Deprecated and replaced on 29 October 2021 |
ProductSelection
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
ProductVariantSelectionInclusion | ProductVariantSelectionIncludeOnly | Deprecated on 6 March 2023, and removed on 30 June 2023. |
ProductVariantSelectionExclusion | ProductVariantSelectionIncludeAllExcept | Deprecated on 6 March 2023, and removed on 30 June 2023. |
ProductSelection.type | ProductSelection.mode | Deprecated on 18 April 2023, and removed on 4 August 2023. |
CreateProductSelectionDraft.type | CreateProductSelectionDraft.mode | Deprecated on 18 April 2023, and removed on 4 August 2023. |
ProductSelectionType | ProductSelectionMode | Deprecated on 18 April 2023, and removed on 4 August 2023. |
ProductSelectionCreatedPayload, IndividualProductSelectionCreatedPayload, IndividualExclusionProductSelectionCreatedPayload | Deprecated and removed on 18 April 2023. |
ShippingMethod
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
description | localizedDescription | Deprecated on 3 March 2020. |
ShippingMethodUpdateAction
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
setDescription | setLocalizedDescription | Deprecated on 3 March 2020. |
TaxCategory
| Deprecated functionality | Alternative functionality | Note |
|---|---|---|
typeId | taxCategoryRef | Deprecated on 17 January 2020. |
OAuth scopes
To restrict access to the minimum, following OAuth scopes have been replaced by more restrictive scopes in the GraphQL API on 2 November 2020.
Cart
| Operation | Previous scope | Current scope |
|---|---|---|
| Mutation (to replicate a Cart) | manage_project:{projectKey} | manage_orders:{projectKey} |
CartDiscount
| Operation | Previous scope | Current scope |
|---|---|---|
| Query | view_orders:{projectKey} | view_cart_discounts:{projectKey} |
| Mutation | manage_orders:{projectKey} | manage_cart_discounts:{projectKey} |
Category
| Operation | Previous scope | Current scope |
|---|---|---|
| Query | view_products:{projectKey} | view_categories:{projectKey} |
| Mutation | manage_products:{projectKey} | manage_categories:{projectKey} |
CustomObject
| Operation | Previous scope | Current scope |
|---|---|---|
| Query | view_products:{projectKey} | view_key_value_documents:{projectKey} |
| Mutation | manage_products:{projectKey} | manage_key_value_documents:{projectKey} |
CustomerGroup
| Operation | Previous scope | Current scope |
|---|---|---|
| Query | view_customers:{projectKey} | view_customer_groups:{projectKey} |
| Mutation | manage_customers:{projectKey} | manage_customer_groups:{projectKey} |
DiscountCode
| Operation | Previous scope | Current scope |
|---|---|---|
| Query | view_orders:{projectKey} | view_discount_codes:{projectKey} |
| Mutation | manage_orders:{projectKey} | manage_discount_codes:{projectKey} |
ShippingMethod
| Operation | Previous scope | Current scope |
|---|---|---|
| Query | view_orders:{projectKey} | view_shipping_methods:{projectKey} |
| Mutation | manage_orders:{projectKey} | manage_shipping_methods:{projectKey} |
State
| Operation | Previous scope | Current scope |
|---|---|---|
| Query | view_orders:{projectKey} | view_states:{projectKey} |
| Mutation | manage_orders:{projectKey} | manage_states:{projectKey} |
TaxCategory
| Operation | Previous scope | Current scope |
|---|---|---|
| Query | view_products:{projectKey} | view_tax_categories:{projectKey} |
| Mutation | manage_products:{projectKey} | manage_tax_categories:{projectKey} |