Documentation
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 key to the following Order types:
  • [API] Added returnItemKey and made returnItemId optional on the following update actions on Orders:
  • [API] Added returnItemKey and made returnItemId optional on the following update actions on Orders Edits:
  • [GraphQL API] Changed the SetStagedOrderReturnPaymentStateOutput type:
    • Added the returnItemKey field to the SetStagedOrderReturnPaymentStateOutput type.
    • SetStagedOrderReturnPaymentStateOutput.returnItemId field type changed from String! to String
  • [GraphQL API] Changed the SetStagedOrderReturnItemCustomType type:
    • Input field returnItemKey was added to SetStagedOrderReturnItemCustomType type
    • SetStagedOrderReturnItemCustomType.returnItemId input field type changed from String! to String
  • [GraphQL API] Changed the SetStagedOrderReturnShipmentState type:
    • Input field returnItemKey was added to SetStagedOrderReturnShipmentState type
    • SetStagedOrderReturnShipmentState.returnItemId input field type changed from String! to String
  • [GraphQL API] Changed the SetOrderReturnItemCustomType type:
    • Input field returnItemKey was added to SetOrderReturnItemCustomType type
    • SetOrderReturnItemCustomType.returnItemId input field type changed from String! to String
  • [GraphQL API] Changed the SetStagedOrderReturnItemCustomTypeOutput type:
    • Added the returnItemKey field to the SetStagedOrderReturnItemCustomTypeOutput type.
    • SetStagedOrderReturnItemCustomTypeOutput.returnItemId field type changed from String! to String
  • [GraphQL API] Changed the ReturnItemDraftTypeOutput type:
    • Added the key field to the ReturnItemDraftTypeOutput type.
  • [GraphQL API] Changed the LineItemReturnItem type:
    • Added the key field to the LineItemReturnItem type.
  • [GraphQL API] Changed the SetStagedOrderReturnItemCustomField type:
    • Input field returnItemKey was added to SetStagedOrderReturnItemCustomField type
    • SetStagedOrderReturnItemCustomField.returnItemId input field type changed from String! to String
  • [GraphQL API] Changed the SetStagedOrderReturnShipmentStateOutput type:
    • SetStagedOrderReturnShipmentStateOutput.returnItemId field type changed from String! to String
    • Added the returnItemKey field to the SetStagedOrderReturnShipmentStateOutput type.
  • [GraphQL API] Changed the CustomLineItemReturnItem type:
    • Added the key field to the CustomLineItemReturnItem type.
  • [GraphQL API] Changed the SetOrderReturnPaymentState type:
    • SetOrderReturnPaymentState.returnItemId input field type changed from String! to String
    • Input field returnItemKey was added to SetOrderReturnPaymentState type
  • [GraphQL API] Changed the SetOrderReturnItemCustomField type:
    • Input field returnItemKey was added to SetOrderReturnItemCustomField type
    • SetOrderReturnItemCustomField.returnItemId input field type changed from String! to String
  • [GraphQL API] Changed the ReturnItem type:
    • Added the key field to the ReturnItem type.
  • [GraphQL API] Changed the ReturnItemDraftType type:
    • Input field key was added to ReturnItemDraftType type
  • [GraphQL API] Changed the SetOrderReturnShipmentState type:
    • Input field returnItemKey was added to SetOrderReturnShipmentState type
    • SetOrderReturnShipmentState.returnItemId input field type changed from String! to String
  • [GraphQL API] Changed the SetStagedOrderReturnPaymentState type:
    • SetStagedOrderReturnPaymentState.returnItemId input field type changed from String! to String
    • Input field returnItemKey was added to SetStagedOrderReturnPaymentState type

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
}