All Release Notes

Introduced 'customLineItemKey' field on update actions related to CustomLineItem

12 July 2023
Composable Commerce
HTTP API
Enhancement
CartsOrdersGraphQL

We introduced the customLineItemKey field on update actions referencing Custom Line Items on Carts, Orders, and Order Edits. The customLineItemId field is now optional on the affected update actions. This ensures a consistent experience when working with external identifiers across different entity types in Composable Commerce.

Changes:

  • [API] Added customLineItemKey and made customLineItemId optional on the following update actions on Carts:
  • [API] Added customLineItemKey and made customLineItemId optional on the following update actions on Orders:
  • [API] Added customLineItemKey and made customLineItemId optional on the following update actions on Order Edits:
  • [GraphQL API] Changed the RemoveStagedOrderCustomLineItemOutput type:
    • RemoveStagedOrderCustomLineItemOutput.customLineItemId field type changed from String! to String
    • Added the customLineItemKey field to the RemoveStagedOrderCustomLineItemOutput type.
  • [GraphQL API] Changed the SetOrderCustomLineItemCustomField type:
    • SetOrderCustomLineItemCustomField.customLineItemId input field type changed from String! to String
    • Input field customLineItemKey was added to SetOrderCustomLineItemCustomField type
  • [GraphQL API] Changed the ChangeStagedOrderCustomLineItemQuantity type:
    • ChangeStagedOrderCustomLineItemQuantity.customLineItemId input field type changed from String! to String
    • Input field customLineItemKey was added to ChangeStagedOrderCustomLineItemQuantity type
  • [GraphQL API] Changed the SetStagedOrderCustomLineItemCustomType type:
    • SetStagedOrderCustomLineItemCustomType.customLineItemId input field type changed from String! to String
    • Input field customLineItemKey was added to SetStagedOrderCustomLineItemCustomType type
  • [GraphQL API] Changed the SetOrderCustomLineItemShippingDetails type:
    • SetOrderCustomLineItemShippingDetails.customLineItemId input field type changed from String! to String
    • Input field customLineItemKey was added to SetOrderCustomLineItemShippingDetails type
  • [GraphQL API] Changed the ChangeCartCustomLineItemMoney type:
    • Input field customLineItemKey was added to ChangeCartCustomLineItemMoney type
    • ChangeCartCustomLineItemMoney.customLineItemId input field type changed from String! to String
  • [GraphQL API] Changed the SetCartCustomLineItemCustomField type:
    • SetCartCustomLineItemCustomField.customLineItemId input field type changed from String! to String
    • Input field customLineItemKey was added to SetCartCustomLineItemCustomField type
  • [GraphQL API] Changed the SetStagedOrderCustomLineItemTaxAmountOutput type:
    • Added the customLineItemKey field to the SetStagedOrderCustomLineItemTaxAmountOutput type.
    • SetStagedOrderCustomLineItemTaxAmountOutput.customLineItemId field type changed from String! to String
  • [GraphQL API] Changed the SetCartCustomLineItemTaxRate type:
    • SetCartCustomLineItemTaxRate.customLineItemId input field type changed from String! to String
    • Input field customLineItemKey was added to SetCartCustomLineItemTaxRate type
  • [GraphQL API] Changed the SetOrderCustomLineItemCustomType type:
    • SetOrderCustomLineItemCustomType.customLineItemId input field type changed from String! to String
    • Input field customLineItemKey was added to SetOrderCustomLineItemCustomType type
  • [GraphQL API] Changed the ChangeCartCustomLineItemPriceMode type:
    • ChangeCartCustomLineItemPriceMode.customLineItemId input field type changed from String! to String
    • Input field customLineItemKey was added to ChangeCartCustomLineItemPriceMode type
  • [GraphQL API] Changed the SetStagedOrderCustomLineItemCustomTypeOutput type:
    • Added the customLineItemKey field to the SetStagedOrderCustomLineItemCustomTypeOutput type.
    • SetStagedOrderCustomLineItemCustomTypeOutput.customLineItemId field type changed from String! to String
  • [GraphQL API] Changed the SetCartCustomLineItemCustomType type:
    • Input field customLineItemKey was added to SetCartCustomLineItemCustomType type
    • SetCartCustomLineItemCustomType.customLineItemId input field type changed from String! to String
  • [GraphQL API] Changed the ChangeStagedOrderCustomLineItemQuantityOutput type:
    • ChangeStagedOrderCustomLineItemQuantityOutput.customLineItemId field type changed from String! to String
    • Added the customLineItemKey field to the ChangeStagedOrderCustomLineItemQuantityOutput type.
  • [GraphQL API] Changed the SetStagedOrderCustomLineItemTaxAmount type:
    • SetStagedOrderCustomLineItemTaxAmount.customLineItemId input field type changed from String! to String
    • Input field customLineItemKey was added to SetStagedOrderCustomLineItemTaxAmount type
  • [GraphQL API] Changed the ChangeStagedOrderCustomLineItemMoneyOutput type:
    • ChangeStagedOrderCustomLineItemMoneyOutput.customLineItemId field type changed from String! to String
    • Added the customLineItemKey field to the ChangeStagedOrderCustomLineItemMoneyOutput type.
  • [GraphQL API] Changed the SetCartCustomLineItemShippingDetails type:
    • Input field customLineItemKey was added to SetCartCustomLineItemShippingDetails type
    • SetCartCustomLineItemShippingDetails.customLineItemId input field type changed from String! to String
  • [GraphQL API] Changed the SetCartCustomLineItemTaxAmount type:
    • Input field customLineItemKey was added to SetCartCustomLineItemTaxAmount type
    • SetCartCustomLineItemTaxAmount.customLineItemId input field type changed from String! to String
  • [GraphQL API] Changed the ChangeCartCustomLineItemQuantity type:
    • ChangeCartCustomLineItemQuantity.customLineItemId input field type changed from String! to String
    • Input field customLineItemKey was added to ChangeCartCustomLineItemQuantity type
  • [GraphQL API] Changed the RemoveStagedOrderCustomLineItem type:
    • Input field customLineItemKey was added to RemoveStagedOrderCustomLineItem type
    • RemoveStagedOrderCustomLineItem.customLineItemId input field type changed from String! to String
  • [GraphQL API] Changed the RemoveCartCustomLineItem type:
    • RemoveCartCustomLineItem.customLineItemId input field type changed from String! to String
    • Input field customLineItemKey was added to RemoveCartCustomLineItem type
  • [GraphQL API] Changed the SetStagedOrderCustomLineItemCustomFieldOutput type:
    • SetStagedOrderCustomLineItemCustomFieldOutput.customLineItemId field type changed from String! to String
    • Added the customLineItemKey field to the SetStagedOrderCustomLineItemCustomFieldOutput type.
  • [GraphQL API] Changed the ApplyCartDeltaToCustomLineItemShippingDetailsTargets type:
    • Input field customLineItemKey was added to ApplyCartDeltaToCustomLineItemShippingDetailsTargets type
    • ApplyCartDeltaToCustomLineItemShippingDetailsTargets.customLineItemId input field type changed from String! to String
  • [GraphQL API] Changed the ChangeStagedOrderCustomLineItemMoney type:
    • ChangeStagedOrderCustomLineItemMoney.customLineItemId input field type changed from String! to String
    • Input field customLineItemKey was added to ChangeStagedOrderCustomLineItemMoney type
  • [GraphQL API] Changed the SetStagedOrderCustomLineItemCustomField type:
    • SetStagedOrderCustomLineItemCustomField.customLineItemId input field type changed from String! to String
    • Input field customLineItemKey was added to SetStagedOrderCustomLineItemCustomField type
  • [GraphQL API] Changed the SetStagedOrderCustomLineItemTaxRate type:
    • Input field customLineItemKey was added to SetStagedOrderCustomLineItemTaxRate type
    • SetStagedOrderCustomLineItemTaxRate.customLineItemId input field type changed from String! to String
  • [GraphQL API] Changed the SetStagedOrderCustomLineItemTaxRateOutput type:
    • SetStagedOrderCustomLineItemTaxRateOutput.customLineItemId field type changed from String! to String
    • Added the customLineItemKey field to the SetStagedOrderCustomLineItemTaxRateOutput type.
  • [GraphQL API] Changed the SetStagedOrderCustomLineItemShippingDetails type:
    • SetStagedOrderCustomLineItemShippingDetails.customLineItemId input field type changed from String! to String
    • Input field customLineItemKey was added to SetStagedOrderCustomLineItemShippingDetails type
  • [GraphQL API] Changed the SetStagedOrderCustomLineItemShippingDetailsOutput type:
    • Added the customLineItemKey field to the SetStagedOrderCustomLineItemShippingDetailsOutput type.
    • SetStagedOrderCustomLineItemShippingDetailsOutput.customLineItemId field type changed from String! to String

The following changes were introduced in terms of GraphQL SDL:

extend type RemoveStagedOrderCustomLineItemOutput {
customLineItemKey: String
}
extend type ChangeStagedOrderCustomLineItemMoneyOutput {
customLineItemKey: String
}
extend type SetStagedOrderCustomLineItemCustomFieldOutput {
customLineItemKey: String
}
extend type SetStagedOrderCustomLineItemTaxRateOutput {
customLineItemKey: String
}
extend type SetStagedOrderCustomLineItemShippingDetailsOutput {
customLineItemKey: String
}
extend type SetStagedOrderCustomLineItemTaxAmountOutput {
customLineItemKey: String
}
extend type SetStagedOrderCustomLineItemCustomTypeOutput {
customLineItemKey: String
}
extend type ChangeStagedOrderCustomLineItemQuantityOutput {
customLineItemKey: String
}
extend input SetCartCustomLineItemCustomType {
customLineItemKey: String
}
extend input SetOrderCustomLineItemCustomField {
customLineItemKey: String
}
extend input SetStagedOrderCustomLineItemTaxAmount {
customLineItemKey: String
}
extend input ChangeStagedOrderCustomLineItemQuantity {
customLineItemKey: String
}
extend input SetStagedOrderCustomLineItemCustomType {
customLineItemKey: String
}
extend input RemoveCartCustomLineItem {
customLineItemKey: String
}
extend input SetOrderCustomLineItemShippingDetails {
customLineItemKey: String
}
extend input ApplyCartDeltaToCustomLineItemShippingDetailsTargets {
customLineItemKey: String
}
extend input ChangeCartCustomLineItemMoney {
customLineItemKey: String
}
extend input ChangeStagedOrderCustomLineItemMoney {
customLineItemKey: String
}
extend input SetStagedOrderCustomLineItemCustomField {
customLineItemKey: String
}
extend input SetStagedOrderCustomLineItemShippingDetails {
customLineItemKey: String
}
extend input SetCartCustomLineItemCustomField {
customLineItemKey: String
}
extend input SetCartCustomLineItemTaxRate {
customLineItemKey: String
}
extend input SetOrderCustomLineItemCustomType {
customLineItemKey: String
}
extend input ChangeCartCustomLineItemPriceMode {
customLineItemKey: String
}
extend input SetCartCustomLineItemShippingDetails {
customLineItemKey: String
}
extend input SetCartCustomLineItemTaxAmount {
customLineItemKey: String
}
extend input ChangeCartCustomLineItemQuantity {
customLineItemKey: String
}
extend input RemoveStagedOrderCustomLineItem {
customLineItemKey: String
}
extend input SetStagedOrderCustomLineItemTaxRate {
customLineItemKey: String
}