Introduced 'lineItemKey' field on Messages related to Order Line Items | HTTP API

Introduced 'lineItemKey' field on Messages related to Order Line Items

14 July 2023

Composable Commerce

HTTP API

Enhancement

OrdersMessages/SubscriptionsGraphQL

We introduced the lineItemKey on Order Messages referencing Line Items. The lineItemKey field is now also available on Transition LineItem State and Import LineItem State update actions on Orders and Order Edits. This ensures a consistent experience when working with external identifiers across different entity types in Composable Commerce.

Changes:

[API] Added lineItemKey and made lineItemId optional on the following update actions on Orders:
- Transition LineItem State and Import LineItem State.
[API] Added lineItemKey and made lineItemId optional on the following update actions on Order Edits:
- Transition LineItem State and Import LineItem State.
[API] Added lineItemKey to the following Order Messages:
- LineItemStateTransition Message, OrderLineItemRemoved Message, OrderLineItemDistributionChannelSet Message, and OrderLineItemDiscountSet Message.
[GraphQL API] Changed the ImportStagedOrderLineItemState type:
- ImportStagedOrderLineItemState.lineItemId input field type changed from String! to String
- Input field lineItemKey was added to ImportStagedOrderLineItemState type
[GraphQL API] Changed the OrderLineItemDiscountSet type:
- Added the lineItemKey field to the OrderLineItemDiscountSet type.
[GraphQL API] Changed the TransitionStagedOrderLineItemStateOutput type:
- Added the lineItemKey field to the TransitionStagedOrderLineItemStateOutput type.
- TransitionStagedOrderLineItemStateOutput.lineItemId field type changed from String! to String
[GraphQL API] Changed the TransitionStagedOrderLineItemState type:
- TransitionStagedOrderLineItemState.lineItemId input field type changed from String! to String
- Input field lineItemKey was added to TransitionStagedOrderLineItemState type
[GraphQL API] Changed the ImportStagedOrderLineItemStateOutput type:
- Added the lineItemKey field to the ImportStagedOrderLineItemStateOutput type.
- ImportStagedOrderLineItemStateOutput.lineItemId field type changed from String! to String
[GraphQL API] Changed the TransitionOrderLineItemState type:
- TransitionOrderLineItemState.lineItemId input field type changed from String! to String
- Input field lineItemKey was added to TransitionOrderLineItemState type
[GraphQL API] Changed the LineItemStateTransition type:
- Added the lineItemKey field to the LineItemStateTransition type.
[GraphQL API] Changed the OrderLineItemRemoved type:
- Added the lineItemKey field to the OrderLineItemRemoved type.
[GraphQL API] Changed the ImportOrderLineItemState type:
- ImportOrderLineItemState.lineItemId input field type changed from String! to String
- Input field lineItemKey was added to ImportOrderLineItemState type
[GraphQL API] Changed the OrderLineItemDistributionChannelSet type:
- Added the lineItemKey field to the OrderLineItemDistributionChannelSet type.

The following changes were introduced in terms of GraphQL SDL:

extend type OrderLineItemDiscountSet {
  lineItemKey: String
}

extend type TransitionStagedOrderLineItemStateOutput {
  lineItemKey: String
}

extend type OrderLineItemRemoved {
  lineItemKey: String
}

extend type ImportStagedOrderLineItemStateOutput {
  lineItemKey: String
}

extend type LineItemStateTransition {
  lineItemKey: String
}

extend type OrderLineItemDistributionChannelSet {
  lineItemKey: String
}

extend input ImportStagedOrderLineItemState {
  lineItemKey: String
}

extend input ImportOrderLineItemState {
  lineItemKey: String
}

extend input TransitionStagedOrderLineItemState {
  lineItemKey: String
}

extend input TransitionOrderLineItemState {
  lineItemKey: String
}