Introduced 'customLineItemKey' field on Orders Messages and update actions | HTTP API

Introduced 'customLineItemKey' field on Orders Messages and update actions

21 July 2023

Composable Commerce

HTTP API

Enhancement

GraphQLOrdersMessages/Subscriptions

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

Changes:

[API] Added customLineItemKey to the following Order Messages:
- CustomLineItemStateTransition Message, OrderCustomLineItemDiscountSet Message, OrderCustomLineItemQuantityChanged Message, and OrderCustomLineItemRemoved Message.
[API] Added key to the following Order Import types:
- CustomLineItemImportDraft and LineItemImportDraft.
[API] Added customLineItemKey and made customerLineItemId optional on the following update actions on Orders:
- Transition LineItem State and Import LineItem State.
[API] Added customLineItemKey and made customerLineItemId optional on the following update actions on Order Edits:
- Transition LineItem State and Import LineItem State.
[GraphQL API] Changed the TransitionStagedOrderCustomLineItemStateOutput type:
- TransitionStagedOrderCustomLineItemStateOutput.customLineItemId field type changed from String! to String
- Added the customLineItemKey field to the TransitionStagedOrderCustomLineItemStateOutput type.
[GraphQL API] Changed the OrderCustomLineItemQuantityChanged type:
- Added the customLineItemKey field to the OrderCustomLineItemQuantityChanged type.
[GraphQL API] Changed the OrderCustomLineItemRemoved type:
- Added the customLineItemKey field to the OrderCustomLineItemRemoved type.
[GraphQL API] Changed the CustomLineItemStateTransition type:
- Added the customLineItemKey field to the CustomLineItemStateTransition type.
[GraphQL API] Changed the ImportStagedOrderCustomLineItemStateOutput type:
- ImportStagedOrderCustomLineItemStateOutput.customLineItemId field type changed from String! to String
- Added the customLineItemKey field to the ImportStagedOrderCustomLineItemStateOutput type.
[GraphQL API] Changed the ImportOrderCustomLineItemState type:
- ImportOrderCustomLineItemState.customLineItemId input field type changed from String! to String
- Input field customLineItemKey was added to ImportOrderCustomLineItemState type
[GraphQL API] Changed the ImportStagedOrderCustomLineItemState type:
- ImportStagedOrderCustomLineItemState.customLineItemId input field type changed from String! to String
- Input field customLineItemKey was added to ImportStagedOrderCustomLineItemState type
[GraphQL API] Changed the TransitionOrderCustomLineItemState type:
- Input field customLineItemKey was added to TransitionOrderCustomLineItemState type
- TransitionOrderCustomLineItemState.customLineItemId input field type changed from String! to String
[GraphQL API] Changed the TransitionStagedOrderCustomLineItemState type:
- Input field customLineItemKey was added to TransitionStagedOrderCustomLineItemState type
- TransitionStagedOrderCustomLineItemState.customLineItemId input field type changed from String! to String
[GraphQL API] Changed the OrderCustomLineItemDiscountSet type:
- Added the customLineItemKey field to the OrderCustomLineItemDiscountSet type.
[GraphQL API] Changed the LineItemImportDraft type:
- Input field key was added to LineItemImportDraft type
[GraphQL API] Changed the CustomLineItemImportDraft type:
- Input field key was added to CustomLineItemImportDraft type

The following changes were introduced in terms of GraphQL SDL:

extend type TransitionStagedOrderCustomLineItemStateOutput {
  customLineItemKey: String
}

extend type OrderCustomLineItemQuantityChanged {
  customLineItemKey: String
}

extend type OrderCustomLineItemDiscountSet {
  customLineItemKey: String
}

extend type OrderCustomLineItemRemoved {
  customLineItemKey: String
}

extend type CustomLineItemStateTransition {
  customLineItemKey: String
}

extend type ImportStagedOrderCustomLineItemStateOutput {
  customLineItemKey: String
}

extend input TransitionOrderCustomLineItemState {
  customLineItemKey: String
}

extend input TransitionStagedOrderCustomLineItemState {
  customLineItemKey: String
}

extend input ImportOrderCustomLineItemState {
  customLineItemKey: String
}

extend input ImportStagedOrderCustomLineItemState {
  customLineItemKey: String
}

extend input LineItemImportDraft {
  key: String
}

extend input CustomLineItemImportDraft {
  key: String
}