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 madecustomLineItemId
optional on the following update actions on Carts:- Remove CustomLineItem, Change CustomLineItem Quantity, Set CustomLineItem TaxRate, Set CustomLineItem TaxAmount, Change CustomLineItem Price Mode, Change CustomLineItem Money, Set CustomLineItem ShippingDetails, Apply DeltaToCustomLineItemShippingDetailsTargets, Set CustomLineItem Custom Type, Set CustomLineItem CustomField.
- [API] Added
customLineItemKey
and madecustomLineItemId
optional on the following update actions on Orders: - [API] Added
customLineItemKey
and madecustomLineItemId
optional on the following update actions on Order Edits: - [GraphQL API] Changed the
RemoveStagedOrderCustomLineItemOutput
type:RemoveStagedOrderCustomLineItemOutput.customLineItemId
field type changed fromString!
toString
- Added the
customLineItemKey
field to theRemoveStagedOrderCustomLineItemOutput
type.
- [GraphQL API] Changed the
SetOrderCustomLineItemCustomField
type:SetOrderCustomLineItemCustomField.customLineItemId
input field type changed fromString!
toString
- Input field
customLineItemKey
was added toSetOrderCustomLineItemCustomField
type
- [GraphQL API] Changed the
ChangeStagedOrderCustomLineItemQuantity
type:ChangeStagedOrderCustomLineItemQuantity.customLineItemId
input field type changed fromString!
toString
- Input field
customLineItemKey
was added toChangeStagedOrderCustomLineItemQuantity
type
- [GraphQL API] Changed the
SetStagedOrderCustomLineItemCustomType
type:SetStagedOrderCustomLineItemCustomType.customLineItemId
input field type changed fromString!
toString
- Input field
customLineItemKey
was added toSetStagedOrderCustomLineItemCustomType
type
- [GraphQL API] Changed the
SetOrderCustomLineItemShippingDetails
type:SetOrderCustomLineItemShippingDetails.customLineItemId
input field type changed fromString!
toString
- Input field
customLineItemKey
was added toSetOrderCustomLineItemShippingDetails
type
- [GraphQL API] Changed the
ChangeCartCustomLineItemMoney
type:- Input field
customLineItemKey
was added toChangeCartCustomLineItemMoney
type ChangeCartCustomLineItemMoney.customLineItemId
input field type changed fromString!
toString
- Input field
- [GraphQL API] Changed the
SetCartCustomLineItemCustomField
type:SetCartCustomLineItemCustomField.customLineItemId
input field type changed fromString!
toString
- Input field
customLineItemKey
was added toSetCartCustomLineItemCustomField
type
- [GraphQL API] Changed the
SetStagedOrderCustomLineItemTaxAmountOutput
type:- Added the
customLineItemKey
field to theSetStagedOrderCustomLineItemTaxAmountOutput
type. SetStagedOrderCustomLineItemTaxAmountOutput.customLineItemId
field type changed fromString!
toString
- Added the
- [GraphQL API] Changed the
SetCartCustomLineItemTaxRate
type:SetCartCustomLineItemTaxRate.customLineItemId
input field type changed fromString!
toString
- Input field
customLineItemKey
was added toSetCartCustomLineItemTaxRate
type
- [GraphQL API] Changed the
SetOrderCustomLineItemCustomType
type:SetOrderCustomLineItemCustomType.customLineItemId
input field type changed fromString!
toString
- Input field
customLineItemKey
was added toSetOrderCustomLineItemCustomType
type
- [GraphQL API] Changed the
ChangeCartCustomLineItemPriceMode
type:ChangeCartCustomLineItemPriceMode.customLineItemId
input field type changed fromString!
toString
- Input field
customLineItemKey
was added toChangeCartCustomLineItemPriceMode
type
- [GraphQL API] Changed the
SetStagedOrderCustomLineItemCustomTypeOutput
type:- Added the
customLineItemKey
field to theSetStagedOrderCustomLineItemCustomTypeOutput
type. SetStagedOrderCustomLineItemCustomTypeOutput.customLineItemId
field type changed fromString!
toString
- Added the
- [GraphQL API] Changed the
SetCartCustomLineItemCustomType
type:- Input field
customLineItemKey
was added toSetCartCustomLineItemCustomType
type SetCartCustomLineItemCustomType.customLineItemId
input field type changed fromString!
toString
- Input field
- [GraphQL API] Changed the
ChangeStagedOrderCustomLineItemQuantityOutput
type:ChangeStagedOrderCustomLineItemQuantityOutput.customLineItemId
field type changed fromString!
toString
- Added the
customLineItemKey
field to theChangeStagedOrderCustomLineItemQuantityOutput
type.
- [GraphQL API] Changed the
SetStagedOrderCustomLineItemTaxAmount
type:SetStagedOrderCustomLineItemTaxAmount.customLineItemId
input field type changed fromString!
toString
- Input field
customLineItemKey
was added toSetStagedOrderCustomLineItemTaxAmount
type
- [GraphQL API] Changed the
ChangeStagedOrderCustomLineItemMoneyOutput
type:ChangeStagedOrderCustomLineItemMoneyOutput.customLineItemId
field type changed fromString!
toString
- Added the
customLineItemKey
field to theChangeStagedOrderCustomLineItemMoneyOutput
type.
- [GraphQL API] Changed the
SetCartCustomLineItemShippingDetails
type:- Input field
customLineItemKey
was added toSetCartCustomLineItemShippingDetails
type SetCartCustomLineItemShippingDetails.customLineItemId
input field type changed fromString!
toString
- Input field
- [GraphQL API] Changed the
SetCartCustomLineItemTaxAmount
type:- Input field
customLineItemKey
was added toSetCartCustomLineItemTaxAmount
type SetCartCustomLineItemTaxAmount.customLineItemId
input field type changed fromString!
toString
- Input field
- [GraphQL API] Changed the
ChangeCartCustomLineItemQuantity
type:ChangeCartCustomLineItemQuantity.customLineItemId
input field type changed fromString!
toString
- Input field
customLineItemKey
was added toChangeCartCustomLineItemQuantity
type
- [GraphQL API] Changed the
RemoveStagedOrderCustomLineItem
type:- Input field
customLineItemKey
was added toRemoveStagedOrderCustomLineItem
type RemoveStagedOrderCustomLineItem.customLineItemId
input field type changed fromString!
toString
- Input field
- [GraphQL API] Changed the
RemoveCartCustomLineItem
type:RemoveCartCustomLineItem.customLineItemId
input field type changed fromString!
toString
- Input field
customLineItemKey
was added toRemoveCartCustomLineItem
type
- [GraphQL API] Changed the
SetStagedOrderCustomLineItemCustomFieldOutput
type:SetStagedOrderCustomLineItemCustomFieldOutput.customLineItemId
field type changed fromString!
toString
- Added the
customLineItemKey
field to theSetStagedOrderCustomLineItemCustomFieldOutput
type.
- [GraphQL API] Changed the
ApplyCartDeltaToCustomLineItemShippingDetailsTargets
type:- Input field
customLineItemKey
was added toApplyCartDeltaToCustomLineItemShippingDetailsTargets
type ApplyCartDeltaToCustomLineItemShippingDetailsTargets.customLineItemId
input field type changed fromString!
toString
- Input field
- [GraphQL API] Changed the
ChangeStagedOrderCustomLineItemMoney
type:ChangeStagedOrderCustomLineItemMoney.customLineItemId
input field type changed fromString!
toString
- Input field
customLineItemKey
was added toChangeStagedOrderCustomLineItemMoney
type
- [GraphQL API] Changed the
SetStagedOrderCustomLineItemCustomField
type:SetStagedOrderCustomLineItemCustomField.customLineItemId
input field type changed fromString!
toString
- Input field
customLineItemKey
was added toSetStagedOrderCustomLineItemCustomField
type
- [GraphQL API] Changed the
SetStagedOrderCustomLineItemTaxRate
type:- Input field
customLineItemKey
was added toSetStagedOrderCustomLineItemTaxRate
type SetStagedOrderCustomLineItemTaxRate.customLineItemId
input field type changed fromString!
toString
- Input field
- [GraphQL API] Changed the
SetStagedOrderCustomLineItemTaxRateOutput
type:SetStagedOrderCustomLineItemTaxRateOutput.customLineItemId
field type changed fromString!
toString
- Added the
customLineItemKey
field to theSetStagedOrderCustomLineItemTaxRateOutput
type.
- [GraphQL API] Changed the
SetStagedOrderCustomLineItemShippingDetails
type:SetStagedOrderCustomLineItemShippingDetails.customLineItemId
input field type changed fromString!
toString
- Input field
customLineItemKey
was added toSetStagedOrderCustomLineItemShippingDetails
type
- [GraphQL API] Changed the
SetStagedOrderCustomLineItemShippingDetailsOutput
type:- Added the
customLineItemKey
field to theSetStagedOrderCustomLineItemShippingDetailsOutput
type. SetStagedOrderCustomLineItemShippingDetailsOutput.customLineItemId
field type changed fromString!
toString
- Added the
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}