All Release Notes
Introduced 'key' field on Return Items
31 July 2023
Composable Commerce
HTTP API
Enhancement
GraphQLOrders
We introduced the key field on LineItemReturnItem, CustomLineItemReturnItem, and ReturnItemDraft. We also introduced returnItemKey on update actions referencing Return Items for Orders and Order Edits. This ensures a consistent experience when working with external identifiers across different entity types in Composable Commerce.
Changes:
- [API] Added
keyto the following Order types: - [API] Added
returnItemKeyand madereturnItemIdoptional on the following update actions on Orders: - [API] Added
returnItemKeyand madereturnItemIdoptional on the following update actions on Orders Edits: - [GraphQL API] Changed the
SetStagedOrderReturnPaymentStateOutputtype:- Added the
returnItemKeyfield to theSetStagedOrderReturnPaymentStateOutputtype. SetStagedOrderReturnPaymentStateOutput.returnItemIdfield type changed fromString!toString
- Added the
- [GraphQL API] Changed the
SetStagedOrderReturnItemCustomTypetype:- Input field
returnItemKeywas added toSetStagedOrderReturnItemCustomTypetype SetStagedOrderReturnItemCustomType.returnItemIdinput field type changed fromString!toString
- Input field
- [GraphQL API] Changed the
SetStagedOrderReturnShipmentStatetype:- Input field
returnItemKeywas added toSetStagedOrderReturnShipmentStatetype SetStagedOrderReturnShipmentState.returnItemIdinput field type changed fromString!toString
- Input field
- [GraphQL API] Changed the
SetOrderReturnItemCustomTypetype:- Input field
returnItemKeywas added toSetOrderReturnItemCustomTypetype SetOrderReturnItemCustomType.returnItemIdinput field type changed fromString!toString
- Input field
- [GraphQL API] Changed the
SetStagedOrderReturnItemCustomTypeOutputtype:- Added the
returnItemKeyfield to theSetStagedOrderReturnItemCustomTypeOutputtype. SetStagedOrderReturnItemCustomTypeOutput.returnItemIdfield type changed fromString!toString
- Added the
- [GraphQL API] Changed the
ReturnItemDraftTypeOutputtype:- Added the
keyfield to theReturnItemDraftTypeOutputtype.
- Added the
- [GraphQL API] Changed the
LineItemReturnItemtype:- Added the
keyfield to theLineItemReturnItemtype.
- Added the
- [GraphQL API] Changed the
SetStagedOrderReturnItemCustomFieldtype:- Input field
returnItemKeywas added toSetStagedOrderReturnItemCustomFieldtype SetStagedOrderReturnItemCustomField.returnItemIdinput field type changed fromString!toString
- Input field
- [GraphQL API] Changed the
SetStagedOrderReturnShipmentStateOutputtype:SetStagedOrderReturnShipmentStateOutput.returnItemIdfield type changed fromString!toString- Added the
returnItemKeyfield to theSetStagedOrderReturnShipmentStateOutputtype.
- [GraphQL API] Changed the
CustomLineItemReturnItemtype:- Added the
keyfield to theCustomLineItemReturnItemtype.
- Added the
- [GraphQL API] Changed the
SetOrderReturnPaymentStatetype:SetOrderReturnPaymentState.returnItemIdinput field type changed fromString!toString- Input field
returnItemKeywas added toSetOrderReturnPaymentStatetype
- [GraphQL API] Changed the
SetOrderReturnItemCustomFieldtype:- Input field
returnItemKeywas added toSetOrderReturnItemCustomFieldtype SetOrderReturnItemCustomField.returnItemIdinput field type changed fromString!toString
- Input field
- [GraphQL API] Changed the
ReturnItemtype:- Added the
keyfield to theReturnItemtype.
- Added the
- [GraphQL API] Changed the
ReturnItemDraftTypetype:- Input field
keywas added toReturnItemDraftTypetype
- Input field
- [GraphQL API] Changed the
SetOrderReturnShipmentStatetype:- Input field
returnItemKeywas added toSetOrderReturnShipmentStatetype SetOrderReturnShipmentState.returnItemIdinput field type changed fromString!toString
- Input field
- [GraphQL API] Changed the
SetStagedOrderReturnPaymentStatetype:SetStagedOrderReturnPaymentState.returnItemIdinput field type changed fromString!toString- Input field
returnItemKeywas added toSetStagedOrderReturnPaymentStatetype
The following changes were introduced in terms of GraphQL SDL:
extend type SetStagedOrderReturnItemCustomFieldOutput {returnItemKey: String}extend type SetStagedOrderReturnPaymentStateOutput {returnItemKey: String}extend interface ReturnItem {key: String}extend type SetStagedOrderReturnItemCustomTypeOutput {returnItemKey: String}extend type ReturnItemDraftTypeOutput {key: String}extend type LineItemReturnItem {key: String}extend type SetStagedOrderReturnShipmentStateOutput {returnItemKey: String}extend type CustomLineItemReturnItem {key: String}extend input SetStagedOrderReturnItemCustomField {returnItemKey: String}extend input SetOrderReturnPaymentState {returnItemKey: String}extend input SetStagedOrderReturnItemCustomType {returnItemKey: String}extend input SetOrderReturnItemCustomField {returnItemKey: String}extend input SetStagedOrderReturnShipmentState {returnItemKey: String}extend input SetOrderReturnItemCustomType {returnItemKey: String}extend input ReturnItemDraftType {key: String}extend input SetOrderReturnShipmentState {returnItemKey: String}extend input SetStagedOrderReturnPaymentState {returnItemKey: String}