Documentation

Functionality removed from Composable Commerce

This page lists all the functionalities that have been removed from the Composable Commerce API endpoints after deprecation.

REST API

Fields on resources

Resource (incl. ResourceDraft)Field
ShippingMethoddescription
CustomFieldsDrafttypeID, typeKey
CustomFieldsDrafttypeId, typeKey
Cart (LineItem, CustomLineItem)discountedPrice
PaymentexternalId, amountAuthorized, amountPaid, amountRefunded, authorizedUntil
PaymentStatusInterfaceCodeSet MessagepaymentId
ProductSelection and Drafttype
TransactionType"AUTHORIZATION", "CHARGE"
Associateroles
CountOnLineItemUnits and CountOnCustomLineItemUnitsexcludeCount

Methods on resources

ResourceMethod
CustomerchangeName update action
ProductsetSKU update action (without staged field) that was replaced by setSku update action with staged field
ShippingMethodsetDescription update action
CustomObjectQuery (without /container)
CustomObjectGet CustomObject by ID
CustomObjectDelete CustomObject by ID
TypechangeFieldDefinitionLabel update action
PaymentsetExternalId, setAuthorization, setAmountRefunded, and setAmountPaid update actions
ProjectchangeMessagesEnabled update action
ProductTypechangeAttributeOrder update action

Objects on resources

ResourceObject
ProductSelectionProductVariantSelectionExclusion
ProductSelectionProductVariantSelectionInclusion
ProductSelectionIndividualExclusionProductSelectionType
ProductSelectionIndividualProductSelectionType
ProductSelectionProductSelectionTypeEnum
SubscriptionIronMqDestination

Query parameters

EndpointMethod
Carts?customerId={id}
Shipping Methods?cartId={id}
Shipping Methods?country={country}
Shipping Methods?orderEditId={orderEditId}

Fields on update actions

Update actionField
Remove Price (on Products)price
Remove Price (on Products)sku
Remove Price (on Products)variantId

GraphQL API

Removed fields

The following list contains fields that have been removed from the GraphQL API followed by their suggested alternatives.

Asset

  • customFieldsRaw : Please use custom.customFieldsRaw.
  • customFields : Please use custom.customFieldsRaw.
  • customFieldList : Typed custom fields are no longer supported, please use customFieldsRaw instead.

Associate

  • roles : Use associateRoleAssignments instead.

Category

  • productCount : The returned number is representing only staged products. Use stagedProductCount instead.
  • customFieldsRaw : Please use custom.customFieldsRaw.
  • customFields : Please use custom.customFieldsRaw.
  • customFieldList : Typed custom fields are no longer supported, please use customFieldsRaw instead.

CategorySearch

  • productCount : The returned number is representing only staged products. Use stagedProductCount instead.
  • customFieldsRaw : Please use custom.customFieldsRaw.
  • customFields : Please use custom.customFieldsRaw.
  • customFieldList : Typed custom fields are no longer supported, please use customFieldsRaw instead.

Cart

  • customFieldsRaw : Please use custom.customFieldsRaw.
  • customFields : Please use custom.customFieldsRaw.
  • customFieldList : Typed custom fields are no longer supported, please use customFieldsRaw instead.

CartDiscount

  • customFieldsRaw : Please use custom.customFieldsRaw.
  • customFields : Please use custom.customFieldsRaw.
  • customFieldList : Typed custom fields are no longer supported, please use customFieldsRaw instead.

Channel

  • typeId : Use channelRef to fetch the reference.
  • customFieldsRaw : Please use custom.customFieldsRaw.
  • customFields : Please use custom.customFieldsRaw.
  • customFieldList : Typed custom fields are no longer supported, please use customFieldsRaw instead.

CountOnCustomLineItemUnits

  • excludeCount : Please use CartDiscountPatternTarget.triggerPattern instead.

CountOnCustomLineItemUnitsInput

  • excludeCount : Please use CartDiscountPatternTargetInput.triggerPattern instead.

CountOnLineItemUnits

  • excludeCount : Please use CartDiscountPatternTarget.triggerPattern instead.

CountOnLineItemUnitsInput

  • excludeCount : Please use CartDiscountPatternTargetInput.triggerPattern instead.

Customer

  • contactInfo : Please use email.
  • customFieldsRaw : Please use custom.customFieldsRaw.
  • customFields : Please use custom.customFieldsRaw.
  • customFieldList : Typed custom fields are no longer supported, please use customFieldsRaw instead.

CustomerGroup

  • typeId : Use customerGroupRef to fetch the reference.
  • customFieldsRaw : Please use custom.customFieldsRaw.
  • customFields : Please use custom.customFieldsRaw.
  • customFieldList : Typed custom fields are no longer supported, please use customFieldsRaw instead.

CustomFieldsType

  • customFields : Typed custom fields are no longer supported, please use customFieldsRaw instead.

CustomLineItem

  • customFieldsRaw : Please use custom.customFieldsRaw.
  • customFields : Please use custom.customFieldsRaw.
  • customFieldList : Typed custom fields are no longer supported, please use customFieldsRaw instead.

CustomFieldsCommand

  • type : Use typeResId to fetch the resource identifier.

CustomLineItemDraftOutput

  • taxCategory : Use taxCategoryResId to fetch the resource identifier.

DiscountCode

  • customFieldsRaw : Please use custom.customFieldsRaw.
  • customFields : Please use custom.customFieldsRaw.
  • customFieldList : Typed custom fields are no longer supported, please use customFieldsRaw instead.

DiscountedProductPriceValue

  • discountRel : Please use discount.

Initiator

  • customer : Use customerRef to fetch the reference.
  • user : Use userRef to fetch the reference.

InventoryEntry

  • customFieldsRaw : Please use custom.customFieldsRaw.
  • customFields : Please use custom.customFieldsRaw.
  • customFieldList : Typed custom fields are no longer supported, please use customFieldsRaw instead.

LineItem

  • customFieldsRaw : Please use custom.customFieldsRaw.
  • customFields : Please use custom.customFieldsRaw.
  • customFieldList : Typed custom fields are no longer supported, please use customFieldsRaw instead.

LineItemDraftOutput

  • distributionChannel : Use distributionChannelResId to fetch the resource identifier.
  • supplyChannel : Use supplyChannelResId to fetch the resource identifier.

NestedAttributeDefinitionType

  • typeReference : Use typeRef to fetch the reference.

Order

  • customFieldsRaw : Please use custom.customFieldsRaw.
  • customFields : Please use custom.customFieldsRaw.
  • customFieldList : Typed custom fields are no longer supported, please use customFieldsRaw instead.

Payment

Product

  • catalogData : Only masterData supported.

ProductPrice

  • customFieldsRaw : Please use custom.customFieldsRaw.
  • customFields : Please use custom.customFieldsRaw.
  • customFieldList : Typed custom fields are no longer supported, please use customFieldsRaw instead.
  • Input field variantId on RemoveProductPrice type, please use priceId instead.
  • Input field sku on RemoveProductPrice type, please use priceId instead.
  • Input field price on RemoveProductPrice type, please use priceId instead.

ProductProjectionMessagePayload

  • masterData : Please use masterVariant.

ProductSelection

  • ProductSelection.type: Please use ProductSelection.mode instead.
  • CreateProductSelectionDraft.type: Please use CreateProductSelectionDraft.mode instead.
  • ProductVariantSelectionInclusion: Please use ProductVariantSelectionIncludeOnly.
  • ProductVariantSelectionExclusion: Please use ProductVariantSelectionIncludeAllExcept.
  • ProductSelectionType: Please use ProductSelectionMode instead.
  • IndividualExclusionProductSelectionCreatedPayload, IndividualProductSelectionCreatedPayload, ProductSelectionCreatedPayload

ProductVariant

  • attributes : Typed attributes are no longer supported, please use attributesRaw instead.
  • attributeList : Typed attributes are no longer supported, please use attributesRaw instead.

ShippingMethod

  • description : Use localizedDescription.

TaxCategory

  • typeId : Use taxCategoryRef to fetch the reference.

Removed OAuth scopes

The following list contains OAuth scopes that have been removed from the GraphQL API followed by their suggested alternatives.

Category

  • Querying: view_products:{projectKey} , please use view_categories:{projectKey} instead.
  • Mutating: manage_products:{projectKey} , please use manage_categories:{projectKey} instead.

Cart

  • Replicate a Cart: manage_project:{projectKey} , please use manage_orders:{projectKey} instead.

CartDiscount

  • Querying: view_orders:{projectKey} , please use view_cart_discounts:{projectKey} instead.
  • Mutating: manage_orders:{projectKey} , please use manage_cart_discounts:{projectKey} instead.

CustomerGroup

  • Querying: view_customers:{projectKey} , please use view_customer_groups:{projectKey} instead.
  • Mutating: manage_customers:{projectKey} , please use manage_customer_groups:{projectKey} instead.

CustomObject

  • Querying: view_products:{projectKey} , please use view_key_value_documents:{projectKey} instead.
  • Mutating: manage_products:{projectKey} , please use manage_key_value_documents:{projectKey} instead.

DiscountCode

  • Querying: view_orders:{projectKey} , please use view_discount_codes:{projectKey} instead.
  • Mutating: manage_orders:{projectKey} , please use manage_discount_codes:{projectKey} instead.

ShippingMethod

  • Querying: view_orders:{projectKey} , please use view_shipping_methods:{projectKey} instead.
  • Mutating: manage_orders:{projectKey} , please use manage_shipping_methods:{projectKey} instead.

State

  • Querying: view_orders:{projectKey} , please use view_states:{projectKey} instead.
  • Mutating: manage_orders:{projectKey} , please use manage_states:{projectKey} instead.

TaxCategory

  • Querying: view_products:{projectKey} , please use view_tax_categories:{projectKey} instead.
  • Mutating: manage_products:{projectKey} , please use manage_tax_categories:{projectKey} instead.