17 May 2023
OrdersGraphQL
We introduced the 
key field on Delivery and DeliveryDraft. This ensures a consistent experience when working with external identifiers across different entity types in Composable Commerce.Changes:
- 
[API] Added the
deliveryKeyfield to the following update actions on Orders: - 
[API] Added the
deliveryKeyfield to the following update actions on Order Edits: - 
[API] Changed the
deliveryIdfield to be optional on the following update actions on Orders: - 
[API] Changed the
deliveryIdfield to be optional on the following update actions on Order Edits: - 
[GraphQL API] Changed the
SetStagedOrderDeliveryCustomFieldtype:- Input field 
deliveryKeywas added toSetStagedOrderDeliveryCustomFieldtype SetStagedOrderDeliveryCustomField.deliveryIdinput field type changed fromString!toString
 - Input field 
 - 
[GraphQL API] Changed the
AddStagedOrderDeliveryOutputtype:- Added the 
deliveryKeyfield to theAddStagedOrderDeliveryOutputtype. 
 - Added the 
 - 
[GraphQL API] Changed the
SetStagedOrderDeliveryAddressOutputtype:SetStagedOrderDeliveryAddressOutput.deliveryIdfield type changed fromString!toString- Added the 
deliveryKeyfield to theSetStagedOrderDeliveryAddressOutputtype. 
 - 
[GraphQL API] Changed the
Deliverytype:- Added the 
keyfield to theDeliverytype. 
 - Added the 
 - 
[GraphQL API] Changed the
SetStagedOrderDeliveryAddressCustomTypetype:- Input field 
deliveryKeywas added toSetStagedOrderDeliveryAddressCustomTypetype SetStagedOrderDeliveryAddressCustomType.deliveryIdinput field type changed fromString!toString
 - Input field 
 - 
[GraphQL API] Changed the
AddStagedOrderDeliverytype:- Input field 
deliveryKeywas added toAddStagedOrderDeliverytype 
 - Input field 
 - 
[GraphQL API] Changed the
SetStagedOrderDeliveryItemsOutputtype:- Added the 
deliveryKeyfield to theSetStagedOrderDeliveryItemsOutputtype. SetStagedOrderDeliveryItemsOutput.deliveryIdfield type changed fromString!toString
 - Added the 
 - 
[GraphQL API] Changed the
SetStagedOrderDeliveryAddresstype:- Input field 
deliveryKeywas added toSetStagedOrderDeliveryAddresstype SetStagedOrderDeliveryAddress.deliveryIdinput field type changed fromString!toString
 - Input field 
 - 
[GraphQL API] Changed the
SetStagedOrderDeliveryAddressCustomTypeOutputtype:- Added the 
deliveryKeyfield to theSetStagedOrderDeliveryAddressCustomTypeOutputtype. SetStagedOrderDeliveryAddressCustomTypeOutput.deliveryIdfield type changed fromString!toString
 - Added the 
 - 
[GraphQL API] Changed the
SetOrderDeliveryAddressCustomFieldtype:SetOrderDeliveryAddressCustomField.deliveryIdinput field type changed fromString!toString- Input field 
deliveryKeywas added toSetOrderDeliveryAddressCustomFieldtype 
 - 
[GraphQL API] Changed the
SetStagedOrderDeliveryCustomTypetype:SetStagedOrderDeliveryCustomType.deliveryIdinput field type changed fromString!toString- Input field 
deliveryKeywas added toSetStagedOrderDeliveryCustomTypetype 
 - 
[GraphQL API] Changed the
DeliveryDrafttype:- Input field 
keywas added toDeliveryDrafttype 
 - Input field 
 - 
[GraphQL API] Changed the
RemoveStagedOrderDeliveryOutputtype:- Added the 
deliveryKeyfield to theRemoveStagedOrderDeliveryOutputtype. RemoveStagedOrderDeliveryOutput.deliveryIdfield type changed fromString!toString
 - Added the 
 - 
[GraphQL API] Changed the
RemoveStagedOrderDeliverytype:RemoveStagedOrderDelivery.deliveryIdinput field type changed fromString!toString- Input field 
deliveryKeywas added toRemoveStagedOrderDeliverytype 
 - 
[GraphQL API] Changed the
AddOrderDeliverytype:- Input field 
deliveryKeywas added toAddOrderDeliverytype 
 - Input field 
 - 
[GraphQL API] Changed the
SetStagedOrderDeliveryCustomFieldOutputtype:- Added the 
deliveryKeyfield to theSetStagedOrderDeliveryCustomFieldOutputtype. SetStagedOrderDeliveryCustomFieldOutput.deliveryIdfield type changed fromString!toString
 - Added the 
 - 
[GraphQL API] Changed the
SetStagedOrderDeliveryAddressCustomFieldOutputtype:SetStagedOrderDeliveryAddressCustomFieldOutput.deliveryIdfield type changed fromString!toString- Added the 
deliveryKeyfield to theSetStagedOrderDeliveryAddressCustomFieldOutputtype. 
 - 
[GraphQL API] Changed the
AddStagedOrderParcelToDeliverytype:- Input field 
deliveryKeywas added toAddStagedOrderParcelToDeliverytype AddStagedOrderParcelToDelivery.deliveryIdinput field type changed fromString!toString
 - Input field 
 - 
[GraphQL API] Changed the
SetOrderDeliveryAddresstype:SetOrderDeliveryAddress.deliveryIdinput field type changed fromString!toString- Input field 
deliveryKeywas added toSetOrderDeliveryAddresstype 
 - 
[GraphQL API] Changed the
AddOrderParcelToDeliverytype:AddOrderParcelToDelivery.deliveryIdinput field type changed fromString!toString- Input field 
deliveryKeywas added toAddOrderParcelToDeliverytype 
 - 
[GraphQL API] Changed the
RemoveOrderDeliverytype:RemoveOrderDelivery.deliveryIdinput field type changed fromString!toString- Input field 
deliveryKeywas added toRemoveOrderDeliverytype 
 - 
[GraphQL API] Changed the
SetOrderDeliveryCustomTypetype:- Input field 
deliveryKeywas added toSetOrderDeliveryCustomTypetype SetOrderDeliveryCustomType.deliveryIdinput field type changed fromString!toString
 - Input field 
 - 
[GraphQL API] Changed the
SetOrderDeliveryCustomFieldtype:SetOrderDeliveryCustomField.deliveryIdinput field type changed fromString!toString- Input field 
deliveryKeywas added toSetOrderDeliveryCustomFieldtype 
 - 
[GraphQL API] Changed the
SetStagedOrderDeliveryItemstype:SetStagedOrderDeliveryItems.deliveryIdinput field type changed fromString!toString- Input field 
deliveryKeywas added toSetStagedOrderDeliveryItemstype 
 - 
[GraphQL API] Changed the
SetStagedOrderDeliveryCustomTypeOutputtype:- Added the 
deliveryKeyfield to theSetStagedOrderDeliveryCustomTypeOutputtype. SetStagedOrderDeliveryCustomTypeOutput.deliveryIdfield type changed fromString!toString
 - Added the 
 - 
[GraphQL API] Changed the
SetOrderDeliveryAddressCustomTypetype:- Input field 
deliveryKeywas added toSetOrderDeliveryAddressCustomTypetype SetOrderDeliveryAddressCustomType.deliveryIdinput field type changed fromString!toString
 - Input field 
 - 
[GraphQL API] Changed the
SetStagedOrderDeliveryAddressCustomFieldtype:SetStagedOrderDeliveryAddressCustomField.deliveryIdinput field type changed fromString!toString- Input field 
deliveryKeywas added toSetStagedOrderDeliveryAddressCustomFieldtype 
 - 
[GraphQL API] Changed the
AddStagedOrderParcelToDeliveryOutputtype:- Added the 
deliveryKeyfield to theAddStagedOrderParcelToDeliveryOutputtype. AddStagedOrderParcelToDeliveryOutput.deliveryIdfield type changed fromString!toString
 - Added the 
 - 
[GraphQL API] Changed the
SetOrderDeliveryItemstype:SetOrderDeliveryItems.deliveryIdinput field type changed fromString!toString- Input field 
deliveryKeywas added toSetOrderDeliveryItemstype 
 
The following changes were introduced in terms of GraphQL SDL:
extend type AddStagedOrderDeliveryOutput {
  deliveryKey: String
}
extend type RemoveStagedOrderDeliveryOutput {
  deliveryKey: String
}
extend type Delivery {
  key: String
}
extend type SetStagedOrderDeliveryItemsOutput {
  deliveryKey: String
}
extend type SetStagedOrderDeliveryAddressCustomTypeOutput {
  deliveryKey: String
}
extend type AddStagedOrderParcelToDeliveryOutput {
  deliveryKey: String
}
extend type SetStagedOrderDeliveryCustomFieldOutput {
  deliveryKey: String
}
extend type SetStagedOrderDeliveryAddressCustomFieldOutput {
  deliveryKey: String
}
extend type SetStagedOrderDeliveryCustomTypeOutput {
  deliveryKey: String
}
extend input SetStagedOrderDeliveryCustomField {
  deliveryKey: String
}
extend input RemoveStagedOrderDelivery {
  deliveryKey: String
}
extend input AddOrderDelivery {
  deliveryKey: String
}
extend input SetStagedOrderDeliveryAddressCustomType {
  deliveryKey: String
}
extend input AddStagedOrderDelivery {
  deliveryKey: String
}
extend input SetStagedOrderDeliveryAddress {
  deliveryKey: String
}
extend input SetOrderDeliveryCustomField {
  deliveryKey: String
}
extend input SetOrderDeliveryAddressCustomField {
  deliveryKey: String
}
extend input SetOrderDeliveryAddressCustomType {
  deliveryKey: String
}
extend input SetStagedOrderDeliveryAddressCustomField {
  deliveryKey: String
}
extend input SetStagedOrderDeliveryCustomType {
  deliveryKey: String
}
extend input SetOrderDeliveryItems {
  deliveryKey: String
}
extend input DeliveryDraft {
  key: String
}
extend input AddStagedOrderParcelToDelivery {
  deliveryKey: String
}
extend input SetOrderDeliveryAddress {
  deliveryKey: String
}
extend input AddOrderParcelToDelivery {
  deliveryKey: String
}
extend input RemoveOrderDelivery {
  deliveryKey: String
}
extend input SetOrderDeliveryCustomType {
  deliveryKey: String
}
extend input SetStagedOrderDeliveryItems {
  deliveryKey: String
}