All Release Notes

Introduced 'key' field on Parcel

6 June 2023
Enhancement
OrdersGraphQL

We introduced the key field on Parcel and ParcelDraft. This ensures a consistent experience when working with external identifiers across different entity types in Composable Commerce.

Changes:

  • [API] Added the key field to Parcel and ParcelDraft.
  • [API] Added the parcelKey field and changed the parcelId field to be optional on the following Order and StagedOrderUpdateAction update actions:
  • [API] Added the parcelKey field to the Add Parcel update action on Order and StagedOrderUpdateAction.
  • [GraphQL API] Changed the Parcel type:
    • Added the key field to the Parcel type.
  • [GraphQL API] Changed the ParcelDraft type:
    • Input field key was added to ParcelDraft type
  • [GraphQL API] Changed the SetStagedOrderParcelCustomTypeOutput type:
    • Added the parcelKey field to the SetStagedOrderParcelCustomTypeOutput type.
    • SetStagedOrderParcelCustomTypeOutput.parcelId field type changed from String! to String
  • [GraphQL API] Changed the SetOrderParcelMeasurements type:
    • SetOrderParcelMeasurements.parcelId input field type changed from String! to String
    • Input field parcelKey was added to SetOrderParcelMeasurements type
  • [GraphQL API] Changed the SetStagedOrderParcelCustomType type:
    • SetStagedOrderParcelCustomType.parcelId input field type changed from String! to String
    • Input field parcelKey was added to SetStagedOrderParcelCustomType type
  • [GraphQL API] Changed the SetStagedOrderParcelTrackingData type:
    • SetStagedOrderParcelTrackingData.parcelId input field type changed from String! to String
    • Input field parcelKey was added to SetStagedOrderParcelTrackingData type
  • [GraphQL API] Changed the SetStagedOrderParcelCustomField type:
    • SetStagedOrderParcelCustomField.parcelId input field type changed from String! to String
    • Input field parcelKey was added to SetStagedOrderParcelCustomField type
  • [GraphQL API] Changed the SetStagedOrderParcelMeasurements type:
    • Input field parcelKey was added to SetStagedOrderParcelMeasurements type
    • SetStagedOrderParcelMeasurements.parcelId input field type changed from String! to String
  • [GraphQL API] Changed the AddOrderParcelToDelivery type:
    • Input field parcelKey was added to AddOrderParcelToDelivery type
  • [GraphQL API] Changed the SetStagedOrderParcelTrackingDataOutput type:
    • SetStagedOrderParcelTrackingDataOutput.parcelId field type changed from String! to String
    • Added the parcelKey field to the SetStagedOrderParcelTrackingDataOutput type.
  • [GraphQL API] Changed the SetStagedOrderParcelMeasurementsOutput type:
    • SetStagedOrderParcelMeasurementsOutput.parcelId field type changed from String! to String
    • Added the parcelKey field to the SetStagedOrderParcelMeasurementsOutput type.
  • [GraphQL API] Changed the SetOrderParcelTrackingData type:
    • SetOrderParcelTrackingData.parcelId input field type changed from String! to String
    • Input field parcelKey was added to SetOrderParcelTrackingData type
  • [GraphQL API] Changed the RemoveOrderParcelFromDelivery type:
    • RemoveOrderParcelFromDelivery.parcelId input field type changed from String! to String
    • Input field parcelKey was added to RemoveOrderParcelFromDelivery type
  • [GraphQL API] Changed the ParcelData type:
    • Added the key field to the ParcelData type.
  • [GraphQL API] Changed the AddStagedOrderParcelToDelivery type:
    • Input field parcelKey was added to AddStagedOrderParcelToDelivery type
  • [GraphQL API] Changed the SetStagedOrderParcelItems type:
    • SetStagedOrderParcelItems.parcelId input field type changed from String! to String
    • Input field parcelKey was added to SetStagedOrderParcelItems type
  • [GraphQL API] Changed the SetOrderParcelCustomType type:
    • SetOrderParcelCustomType.parcelId input field type changed from String! to String
    • Input field parcelKey was added to SetOrderParcelCustomType type
  • [GraphQL API] Changed the ParcelDataDraftType type:
    • Input field key was added to ParcelDataDraftType type
  • [GraphQL API] Changed the SetStagedOrderParcelItemsOutput type:
    • SetStagedOrderParcelItemsOutput.parcelId field type changed from String! to String
    • Added the parcelKey field to the SetStagedOrderParcelItemsOutput type.
  • [GraphQL API] Changed the RemoveStagedOrderParcelFromDeliveryOutput type:
    • Added the parcelKey field to the RemoveStagedOrderParcelFromDeliveryOutput type.
    • RemoveStagedOrderParcelFromDeliveryOutput.parcelId field type changed from String! to String
  • [GraphQL API] Changed the SetOrderParcelItems type:
    • Input field parcelKey was added to SetOrderParcelItems type
    • SetOrderParcelItems.parcelId input field type changed from String! to String
  • [GraphQL API] Changed the SetOrderParcelCustomField type:
    • Input field parcelKey was added to SetOrderParcelCustomField type
    • SetOrderParcelCustomField.parcelId input field type changed from String! to String
  • [GraphQL API] Changed the RemoveStagedOrderParcelFromDelivery type:
    • RemoveStagedOrderParcelFromDelivery.parcelId input field type changed from String! to String
    • Input field parcelKey was added to RemoveStagedOrderParcelFromDelivery type
  • [GraphQL API] Changed the SetStagedOrderParcelCustomFieldOutput type:
    • SetStagedOrderParcelCustomFieldOutput.parcelId field type changed from String! to String
    • Added the parcelKey field to the SetStagedOrderParcelCustomFieldOutput type.
  • [GraphQL API] Changed the AddStagedOrderParcelToDeliveryOutput type:
    • Added the parcelKey field to the AddStagedOrderParcelToDeliveryOutput type.

The following changes were introduced in terms of GraphQL SDL:

extend type SetStagedOrderParcelCustomTypeOutput {
parcelKey: String
}
extend type Parcel {
key: String
}
extend type SetStagedOrderParcelMeasurementsOutput {
parcelKey: String
}
extend type ParcelData {
key: String
}
extend type SetStagedOrderParcelTrackingDataOutput {
parcelKey: String
}
extend type SetStagedOrderParcelCustomFieldOutput {
parcelKey: String
}
extend type AddStagedOrderParcelToDeliveryOutput {
parcelKey: String
}
extend type SetStagedOrderParcelItemsOutput {
parcelKey: String
}
extend type RemoveStagedOrderParcelFromDeliveryOutput {
parcelKey: String
}
extend input SetOrderParcelMeasurements {
parcelKey: String
}
extend input SetOrderParcelTrackingData {
parcelKey: String
}
extend input ParcelDraft {
key: String
}
extend input RemoveOrderParcelFromDelivery {
parcelKey: String
}
extend input SetStagedOrderParcelCustomType {
parcelKey: String
}
extend input AddStagedOrderParcelToDelivery {
parcelKey: String
}
extend input SetStagedOrderParcelTrackingData {
parcelKey: String
}
extend input SetStagedOrderParcelCustomField {
parcelKey: String
}
extend input SetStagedOrderParcelMeasurements {
parcelKey: String
}
extend input AddOrderParcelToDelivery {
parcelKey: String
}
extend input SetStagedOrderParcelItems {
parcelKey: String
}
extend input SetOrderParcelCustomType {
parcelKey: String
}
extend input ParcelDataDraftType {
key: String
}
extend input SetOrderParcelItems {
parcelKey: String
}
extend input SetOrderParcelCustomField {
parcelKey: String
}
extend input RemoveStagedOrderParcelFromDelivery {
parcelKey: String
}