All Release Notes
Added 'lineItemKey' to Cart, Order, and Order Edit update actions
23 June 2023
Composable Commerce
HTTP API
Enhancement
CartsOrdersGraphQL
We introduced the lineItemKey
field on update actions referencing Line Items on Carts, Orders, and Order Edits. The lineItemId
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
lineItemKey
and madelineItemId
optional on the following update actions on Carts:- Remove LineItem, Change LineItem Quantity, Set LineItem TaxRate, Set LineItem TaxAmount, Set LineItem Price, Set LineItem TotalPrice, Set LineItem DistributionChannel, Set LineItem SupplyChannel, Set LineItem ShippingDetails, Apply DeltaToLineItemShippingDetailsTargets, Set LineItem Custom Type, Set LineItem CustomField, and Set LineItem InventoryMode.
- [API] Added
lineItemKey
and madelineItemId
optional on the following update actions on My Carts: - [API] Added
lineItemKey
and madelineItemId
optional on the following update actions on Orders: - [API] Added
lineItemKey
and madelineItemId
optional on the following update actions on Order Edits: - [GraphQL API] Changed the
SetCartLineItemTaxAmount
type:SetCartLineItemTaxAmount.lineItemId
input field type changed fromString!
toString
- Input field
lineItemKey
was added toSetCartLineItemTaxAmount
type
- [GraphQL API] Changed the
SetStagedOrderLineItemCustomType
type:- Input field
lineItemKey
was added toSetStagedOrderLineItemCustomType
type SetStagedOrderLineItemCustomType.lineItemId
input field type changed fromString!
toString
- Input field
- [GraphQL API] Changed the
SetCartLineItemCustomField
type:- Input field
lineItemKey
was added toSetCartLineItemCustomField
type SetCartLineItemCustomField.lineItemId
input field type changed fromString!
toString
- Input field
- [GraphQL API] Changed the
ChangeStagedOrderLineItemQuantity
type:- Input field
lineItemKey
was added toChangeStagedOrderLineItemQuantity
type ChangeStagedOrderLineItemQuantity.lineItemId
input field type changed fromString!
toString
- Input field
- [GraphQL API] Changed the
SetCartLineItemShippingDetails
type:SetCartLineItemShippingDetails.lineItemId
input field type changed fromString!
toString
- Input field
lineItemKey
was added toSetCartLineItemShippingDetails
type
- [GraphQL API] Changed the
SetCartLineItemTotalPrice
type:SetCartLineItemTotalPrice.lineItemId
input field type changed fromString!
toString
- Input field
lineItemKey
was added toSetCartLineItemTotalPrice
type
- [GraphQL API] Changed the
SetCartLineItemTaxRate
type:- Input field
lineItemKey
was added toSetCartLineItemTaxRate
type SetCartLineItemTaxRate.lineItemId
input field type changed fromString!
toString
- Input field
- [GraphQL API] Changed the
SetStagedOrderLineItemShippingDetails
type:SetStagedOrderLineItemShippingDetails.lineItemId
input field type changed fromString!
toString
- Input field
lineItemKey
was added toSetStagedOrderLineItemShippingDetails
type
- [GraphQL API] Changed the
SetStagedOrderLineItemCustomField
type:- Input field
lineItemKey
was added toSetStagedOrderLineItemCustomField
type SetStagedOrderLineItemCustomField.lineItemId
input field type changed fromString!
toString
- Input field
- [GraphQL API] Changed the
SetStagedOrderLineItemCustomFieldOutput
type:SetStagedOrderLineItemCustomFieldOutput.lineItemId
field type changed fromString!
toString
- Added the
lineItemKey
field to theSetStagedOrderLineItemCustomFieldOutput
type.
- [GraphQL API] Changed the
SetStagedOrderLineItemTotalPriceOutput
type:- Added the
lineItemKey
field to theSetStagedOrderLineItemTotalPriceOutput
type. SetStagedOrderLineItemTotalPriceOutput.lineItemId
field type changed fromString!
toString
- Added the
- [GraphQL API] Changed the
SetCartLineItemCustomType
type:SetCartLineItemCustomType.lineItemId
input field type changed fromString!
toString
- Input field
lineItemKey
was added toSetCartLineItemCustomType
type
- [GraphQL API] Changed the
SetCartLineItemDistributionChannel
type:- Input field
lineItemKey
was added toSetCartLineItemDistributionChannel
type SetCartLineItemDistributionChannel.lineItemId
input field type changed fromString!
toString
- Input field
- [GraphQL API] Changed the
SetStagedOrderLineItemTaxAmount
type:- Input field
lineItemKey
was added toSetStagedOrderLineItemTaxAmount
type SetStagedOrderLineItemTaxAmount.lineItemId
input field type changed fromString!
toString
- Input field
- [GraphQL API] Changed the
ApplyCartDeltaToLineItemShippingDetailsTargets
type:ApplyCartDeltaToLineItemShippingDetailsTargets.lineItemId
input field type changed fromString!
toString
- Input field
lineItemKey
was added toApplyCartDeltaToLineItemShippingDetailsTargets
type
- [GraphQL API] Changed the
RemoveStagedOrderLineItem
type:RemoveStagedOrderLineItem.lineItemId
input field type changed fromString!
toString
- Input field
lineItemKey
was added toRemoveStagedOrderLineItem
type
- [GraphQL API] Changed the
SetStagedOrderLineItemTaxRateOutput
type:- Added the
lineItemKey
field to theSetStagedOrderLineItemTaxRateOutput
type. SetStagedOrderLineItemTaxRateOutput.lineItemId
field type changed fromString!
toString
- Added the
- [GraphQL API] Changed the
SetStagedOrderLineItemPrice
type:SetStagedOrderLineItemPrice.lineItemId
input field type changed fromString!
toString
- Input field
lineItemKey
was added toSetStagedOrderLineItemPrice
type
- [GraphQL API] Changed the
SetOrderLineItemCustomField
type:- Input field
lineItemKey
was added toSetOrderLineItemCustomField
type SetOrderLineItemCustomField.lineItemId
input field type changed fromString!
toString
- Input field
- [GraphQL API] Changed the
SetStagedOrderLineItemDistributionChannel
type:- Input field
lineItemKey
was added toSetStagedOrderLineItemDistributionChannel
type SetStagedOrderLineItemDistributionChannel.lineItemId
input field type changed fromString!
toString
- Input field
- [GraphQL API] Changed the
SetCartLineItemSupplyChannel
type:SetCartLineItemSupplyChannel.lineItemId
input field type changed fromString!
toString
- Input field
lineItemKey
was added toSetCartLineItemSupplyChannel
type
- [GraphQL API] Changed the
ChangeStagedOrderLineItemQuantityOutput
type:- Added the
lineItemKey
field to theChangeStagedOrderLineItemQuantityOutput
type. ChangeStagedOrderLineItemQuantityOutput.lineItemId
field type changed fromString!
toString
- Added the
- [GraphQL API] Changed the
SetStagedOrderLineItemTaxAmountOutput
type:SetStagedOrderLineItemTaxAmountOutput.lineItemId
field type changed fromString!
toString
- Added the
lineItemKey
field to theSetStagedOrderLineItemTaxAmountOutput
type.
- [GraphQL API] Changed the
SetCartLineItemInventoryMode
type:SetCartLineItemInventoryMode.lineItemId
input field type changed fromString!
toString
- Input field
lineItemKey
was added toSetCartLineItemInventoryMode
type
- [GraphQL API] Changed the
SetStagedOrderLineItemPriceOutput
type:- Added the
lineItemKey
field to theSetStagedOrderLineItemPriceOutput
type. SetStagedOrderLineItemPriceOutput.lineItemId
field type changed fromString!
toString
- Added the
- [GraphQL API] Changed the
RemoveStagedOrderLineItemOutput
type:- Added the
lineItemKey
field to theRemoveStagedOrderLineItemOutput
type. RemoveStagedOrderLineItemOutput.lineItemId
field type changed fromString!
toString
- Added the
- [GraphQL API] Changed the
ChangeCartLineItemQuantity
type:ChangeCartLineItemQuantity.lineItemId
input field type changed fromString!
toString
- Input field
lineItemKey
was added toChangeCartLineItemQuantity
type
- [GraphQL API] Changed the
SetOrderLineItemShippingDetails
type:- Input field
lineItemKey
was added toSetOrderLineItemShippingDetails
type SetOrderLineItemShippingDetails.lineItemId
input field type changed fromString!
toString
- Input field
- [GraphQL API] Changed the
SetStagedOrderLineItemCustomTypeOutput
type:- Added the
lineItemKey
field to theSetStagedOrderLineItemCustomTypeOutput
type. SetStagedOrderLineItemCustomTypeOutput.lineItemId
field type changed fromString!
toString
- Added the
- [GraphQL API] Changed the
SetStagedOrderLineItemDistributionChannelOutput
type:- Added the
lineItemKey
field to theSetStagedOrderLineItemDistributionChannelOutput
type. SetStagedOrderLineItemDistributionChannelOutput.lineItemId
field type changed fromString!
toString
- Added the
- [GraphQL API] Changed the
SetStagedOrderLineItemShippingDetailsOutput
type:SetStagedOrderLineItemShippingDetailsOutput.lineItemId
field type changed fromString!
toString
- Added the
lineItemKey
field to theSetStagedOrderLineItemShippingDetailsOutput
type.
- [GraphQL API] Changed the
SetOrderLineItemCustomType
type:- Input field
lineItemKey
was added toSetOrderLineItemCustomType
type SetOrderLineItemCustomType.lineItemId
input field type changed fromString!
toString
- Input field
- [GraphQL API] Changed the
SetStagedOrderLineItemTotalPrice
type:SetStagedOrderLineItemTotalPrice.lineItemId
input field type changed fromString!
toString
- Input field
lineItemKey
was added toSetStagedOrderLineItemTotalPrice
type
- [GraphQL API] Changed the
SetCartLineItemPrice
type:SetCartLineItemPrice.lineItemId
input field type changed fromString!
toString
- Input field
lineItemKey
was added toSetCartLineItemPrice
type
- [GraphQL API] Changed the
SetStagedOrderLineItemTaxRate
type:SetStagedOrderLineItemTaxRate.lineItemId
input field type changed fromString!
toString
- Input field
lineItemKey
was added toSetStagedOrderLineItemTaxRate
type
- [GraphQL API] Changed the
RemoveCartLineItem
type:- Input field
lineItemKey
was added toRemoveCartLineItem
type RemoveCartLineItem.lineItemId
input field type changed fromString!
toString
- Input field
The following changes were introduced in terms of GraphQL SDL:
extend type SetStagedOrderLineItemTaxRateOutput {lineItemKey: String}extend type SetStagedOrderLineItemPriceOutput {lineItemKey: String}extend type RemoveStagedOrderLineItemOutput {lineItemKey: String}extend type SetStagedOrderLineItemCustomTypeOutput {lineItemKey: String}extend type SetStagedOrderLineItemCustomFieldOutput {lineItemKey: String}extend type SetStagedOrderLineItemTotalPriceOutput {lineItemKey: String}extend type ChangeStagedOrderLineItemQuantityOutput {lineItemKey: String}extend type SetStagedOrderLineItemTaxAmountOutput {lineItemKey: String}extend type SetStagedOrderLineItemDistributionChannelOutput {lineItemKey: String}extend type SetStagedOrderLineItemShippingDetailsOutput {lineItemKey: String}extend input RemoveStagedOrderLineItem {lineItemKey: String}extend input SetCartLineItemTaxAmount {lineItemKey: String}extend input SetStagedOrderLineItemCustomType {lineItemKey: String}extend input SetCartLineItemInventoryMode {lineItemKey: String}extend input SetCartLineItemCustomField {lineItemKey: String}extend input ChangeCartLineItemQuantity {lineItemKey: String}extend input SetOrderLineItemShippingDetails {lineItemKey: String}extend input ChangeStagedOrderLineItemQuantity {lineItemKey: String}extend input SetCartLineItemShippingDetails {lineItemKey: String}extend input SetCartLineItemTotalPrice {lineItemKey: String}extend input SetCartLineItemTaxRate {lineItemKey: String}extend input SetStagedOrderLineItemShippingDetails {lineItemKey: String}extend input SetStagedOrderLineItemCustomField {lineItemKey: String}extend input SetCartLineItemCustomType {lineItemKey: String}extend input SetCartLineItemDistributionChannel {lineItemKey: String}extend input SetCartShippingMethodTaxRate {shippingKey: String}extend input SetStagedOrderLineItemTaxAmount {lineItemKey: String}extend input ApplyCartDeltaToLineItemShippingDetailsTargets {lineItemKey: String}extend input SetStagedOrderLineItemPrice {lineItemKey: String}extend input SetOrderLineItemCustomField {lineItemKey: String}extend input SetStagedOrderLineItemDistributionChannel {lineItemKey: String}extend input SetCartLineItemSupplyChannel {lineItemKey: String}extend input SetOrderLineItemCustomType {lineItemKey: String}extend input SetStagedOrderLineItemTotalPrice {lineItemKey: String}extend input SetCartLineItemPrice {lineItemKey: String}extend input SetCartShippingMethodTaxAmount {shippingKey: String}extend input SetStagedOrderLineItemTaxRate {lineItemKey: String}extend input RemoveCartLineItem {lineItemKey: String}