All Release Notes

Introduced 'key' field on ShoppingListLineItem and TextLineItem

11 August 2023
Composable Commerce
HTTP API
Enhancement
GraphQLCarts

We introduced the key field on ShoppingListLineItem, ShoppingListLineItemDraft, TextLineItem, and TextLineItemDraft. We also added lineItemKey and textLineItemKey on update actions referencing Shopping List Line Items and Text Line Items. This ensures a consistent experience when working with external identifiers across different entity types in Composable Commerce.

Changes:

  • [API] Added key to the following Shopping List types:
  • [API] Added the optional key field on the following update actions on Shopping Lists and My Shopping Lists:
  • [API] Added lineItemKey and made lineItemId optional on the following update actions on ShoppingLists and My Shopping Lists:
  • [GraphQL API] Changed the SetShoppingListTextLineItemDescription type:
    • SetShoppingListTextLineItemDescription.textLineItemId input field type changed from String! to String
    • Input field textLineItemKey was added to SetShoppingListTextLineItemDescription type
  • [GraphQL API] Changed the TextLineItemDraft type:
    • Input field key was added to TextLineItemDraft type
  • [GraphQL API] Changed the SetShoppingListTextLineItemCustomType type:
    • SetShoppingListTextLineItemCustomType.textLineItemId input field type changed from String! to String
    • Input field textLineItemKey was added to SetShoppingListTextLineItemCustomType type
  • [GraphQL API] Changed the ShoppingListLineItem type:
    • Added the key field to the ShoppingListLineItem type.
  • [GraphQL API] Changed the TextLineItem type:
    • Added the key field to the TextLineItem type.
  • [GraphQL API] Changed the SetShoppingListTextLineItemCustomField type:
    • SetShoppingListTextLineItemCustomField.textLineItemId input field type changed from String! to String
    • Input field textLineItemKey was added to SetShoppingListTextLineItemCustomField type
  • [GraphQL API] Changed the ChangeShoppingListLineItemQuantity type:
    • Input field lineItemKey was added to ChangeShoppingListLineItemQuantity type
    • ChangeShoppingListLineItemQuantity.lineItemId input field type changed from String! to String
  • [GraphQL API] Changed the ChangeShoppingListTextLineItemName type:
    • ChangeShoppingListTextLineItemName.textLineItemId input field type changed from String! to String
    • Input field textLineItemKey was added to ChangeShoppingListTextLineItemName type
  • [GraphQL API] Changed the ChangeShoppingListTextLineItemQuantity type:
    • ChangeShoppingListTextLineItemQuantity.textLineItemId input field type changed from String! to String
    • Input field textLineItemKey was added to ChangeShoppingListTextLineItemQuantity type
  • [GraphQL API] Changed the ShoppingListLineItemDraft type:
    • Input field key was added to ShoppingListLineItemDraft type
  • [GraphQL API] Changed the RemoveShoppingListTextLineItem type:
    • RemoveShoppingListTextLineItem.textLineItemId input field type changed from String! to String
    • Input field textLineItemKey was added to RemoveShoppingListTextLineItem type
  • [GraphQL API] Changed the AddShoppingListLineItem type:
    • Input field key was added to AddShoppingListLineItem type
  • [GraphQL API] Changed the SetStagedOrderCustomLineItemTaxAmount type:
    • Input field shippingKey was added to SetStagedOrderCustomLineItemTaxAmount type
  • [GraphQL API] Changed the RemoveShoppingListLineItem type:
    • RemoveShoppingListLineItem.lineItemId input field type changed from String! to String
    • Input field lineItemKey was added to RemoveShoppingListLineItem type
  • [GraphQL API] Changed the SetShoppingListLineItemCustomType type:
    • SetShoppingListLineItemCustomType.lineItemId input field type changed from String! to String
    • Input field lineItemKey was added to SetShoppingListLineItemCustomType type
  • [GraphQL API] Changed the AddShoppingListTextLineItem type:
    • Input field key was added to AddShoppingListTextLineItem type
  • [GraphQL API] Changed the SetShoppingListLineItemCustomField type:
    • Input field lineItemKey was added to SetShoppingListLineItemCustomField type
    • SetShoppingListLineItemCustomField.lineItemId input field type changed from String! to String

The following changes were introduced in terms of GraphQL SDL:

extend type ShoppingListLineItem {
key: String
}
extend type TextLineItem {
key: String
}
extend input SetShoppingListTextLineItemDescription {
textLineItemKey: String
}
extend input TextLineItemDraft {
key: String
}
extend input SetShoppingListLineItemCustomField {
lineItemKey: String
}
extend input SetShoppingListTextLineItemCustomType {
textLineItemKey: String
}
extend input SetShoppingListTextLineItemCustomField {
textLineItemKey: String
}
extend input ChangeShoppingListLineItemQuantity {
lineItemKey: String
}
extend input ChangeShoppingListTextLineItemName {
textLineItemKey: String
}
extend input ChangeShoppingListTextLineItemQuantity {
textLineItemKey: String
}
extend input ShoppingListLineItemDraft {
key: String
}
extend input RemoveShoppingListTextLineItem {
textLineItemKey: String
}
extend input AddShoppingListLineItem {
key: String
}
extend input RemoveShoppingListLineItem {
lineItemKey: String
}
extend input SetShoppingListLineItemCustomType {
lineItemKey: String
}
extend input AddShoppingListTextLineItem {
key: String
}