All Release Notes

Introduced 'key' field on Delivery

17 May 2023
Composable Commerce
HTTP API
Enhancement
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 key field to Delivery and DeliveryDraft.

  • [API] Added the deliveryKey field to the following update actions on Orders:

  • [API] Added the deliveryKey field to the following update actions on Order Edits:

  • [API] Changed the deliveryId field to be optional on the following update actions on Orders:

  • [API] Changed the deliveryId field to be optional on the following update actions on Order Edits:

  • [GraphQL API] Changed the SetStagedOrderDeliveryCustomField type:

    • Input field deliveryKey was added to SetStagedOrderDeliveryCustomField type
    • SetStagedOrderDeliveryCustomField.deliveryId input field type changed from String! to String
  • [GraphQL API] Changed the AddStagedOrderDeliveryOutput type:

    • Added the deliveryKey field to the AddStagedOrderDeliveryOutput type.
  • [GraphQL API] Changed the SetStagedOrderDeliveryAddressOutput type:

    • SetStagedOrderDeliveryAddressOutput.deliveryId field type changed from String! to String
    • Added the deliveryKey field to the SetStagedOrderDeliveryAddressOutput type.
  • [GraphQL API] Changed the Delivery type:

    • Added the key field to the Delivery type.
  • [GraphQL API] Changed the SetStagedOrderDeliveryAddressCustomType type:

    • Input field deliveryKey was added to SetStagedOrderDeliveryAddressCustomType type
    • SetStagedOrderDeliveryAddressCustomType.deliveryId input field type changed from String! to String
  • [GraphQL API] Changed the AddStagedOrderDelivery type:

    • Input field deliveryKey was added to AddStagedOrderDelivery type
  • [GraphQL API] Changed the SetStagedOrderDeliveryItemsOutput type:

    • Added the deliveryKey field to the SetStagedOrderDeliveryItemsOutput type.
    • SetStagedOrderDeliveryItemsOutput.deliveryId field type changed from String! to String
  • [GraphQL API] Changed the SetStagedOrderDeliveryAddress type:

    • Input field deliveryKey was added to SetStagedOrderDeliveryAddress type
    • SetStagedOrderDeliveryAddress.deliveryId input field type changed from String! to String
  • [GraphQL API] Changed the SetStagedOrderDeliveryAddressCustomTypeOutput type:

    • Added the deliveryKey field to the SetStagedOrderDeliveryAddressCustomTypeOutput type.
    • SetStagedOrderDeliveryAddressCustomTypeOutput.deliveryId field type changed from String! to String
  • [GraphQL API] Changed the SetOrderDeliveryAddressCustomField type:

    • SetOrderDeliveryAddressCustomField.deliveryId input field type changed from String! to String
    • Input field deliveryKey was added to SetOrderDeliveryAddressCustomField type
  • [GraphQL API] Changed the SetStagedOrderDeliveryCustomType type:

    • SetStagedOrderDeliveryCustomType.deliveryId input field type changed from String! to String
    • Input field deliveryKey was added to SetStagedOrderDeliveryCustomType type
  • [GraphQL API] Changed the DeliveryDraft type:

    • Input field key was added to DeliveryDraft type
  • [GraphQL API] Changed the RemoveStagedOrderDeliveryOutput type:

    • Added the deliveryKey field to the RemoveStagedOrderDeliveryOutput type.
    • RemoveStagedOrderDeliveryOutput.deliveryId field type changed from String! to String
  • [GraphQL API] Changed the RemoveStagedOrderDelivery type:

    • RemoveStagedOrderDelivery.deliveryId input field type changed from String! to String
    • Input field deliveryKey was added to RemoveStagedOrderDelivery type
  • [GraphQL API] Changed the AddOrderDelivery type:

    • Input field deliveryKey was added to AddOrderDelivery type
  • [GraphQL API] Changed the SetStagedOrderDeliveryCustomFieldOutput type:

    • Added the deliveryKey field to the SetStagedOrderDeliveryCustomFieldOutput type.
    • SetStagedOrderDeliveryCustomFieldOutput.deliveryId field type changed from String! to String
  • [GraphQL API] Changed the SetStagedOrderDeliveryAddressCustomFieldOutput type:

    • SetStagedOrderDeliveryAddressCustomFieldOutput.deliveryId field type changed from String! to String
    • Added the deliveryKey field to the SetStagedOrderDeliveryAddressCustomFieldOutput type.
  • [GraphQL API] Changed the AddStagedOrderParcelToDelivery type:

    • Input field deliveryKey was added to AddStagedOrderParcelToDelivery type
    • AddStagedOrderParcelToDelivery.deliveryId input field type changed from String! to String
  • [GraphQL API] Changed the SetOrderDeliveryAddress type:

    • SetOrderDeliveryAddress.deliveryId input field type changed from String! to String
    • Input field deliveryKey was added to SetOrderDeliveryAddress type
  • [GraphQL API] Changed the AddOrderParcelToDelivery type:

    • AddOrderParcelToDelivery.deliveryId input field type changed from String! to String
    • Input field deliveryKey was added to AddOrderParcelToDelivery type
  • [GraphQL API] Changed the RemoveOrderDelivery type:

    • RemoveOrderDelivery.deliveryId input field type changed from String! to String
    • Input field deliveryKey was added to RemoveOrderDelivery type
  • [GraphQL API] Changed the SetOrderDeliveryCustomType type:

    • Input field deliveryKey was added to SetOrderDeliveryCustomType type
    • SetOrderDeliveryCustomType.deliveryId input field type changed from String! to String
  • [GraphQL API] Changed the SetOrderDeliveryCustomField type:

    • SetOrderDeliveryCustomField.deliveryId input field type changed from String! to String
    • Input field deliveryKey was added to SetOrderDeliveryCustomField type
  • [GraphQL API] Changed the SetStagedOrderDeliveryItems type:

    • SetStagedOrderDeliveryItems.deliveryId input field type changed from String! to String
    • Input field deliveryKey was added to SetStagedOrderDeliveryItems type
  • [GraphQL API] Changed the SetStagedOrderDeliveryCustomTypeOutput type:

    • Added the deliveryKey field to the SetStagedOrderDeliveryCustomTypeOutput type.
    • SetStagedOrderDeliveryCustomTypeOutput.deliveryId field type changed from String! to String
  • [GraphQL API] Changed the SetOrderDeliveryAddressCustomType type:

    • Input field deliveryKey was added to SetOrderDeliveryAddressCustomType type
    • SetOrderDeliveryAddressCustomType.deliveryId input field type changed from String! to String
  • [GraphQL API] Changed the SetStagedOrderDeliveryAddressCustomField type:

    • SetStagedOrderDeliveryAddressCustomField.deliveryId input field type changed from String! to String
    • Input field deliveryKey was added to SetStagedOrderDeliveryAddressCustomField type
  • [GraphQL API] Changed the AddStagedOrderParcelToDeliveryOutput type:

    • Added the deliveryKey field to the AddStagedOrderParcelToDeliveryOutput type.
    • AddStagedOrderParcelToDeliveryOutput.deliveryId field type changed from String! to String
  • [GraphQL API] Changed the SetOrderDeliveryItems type:

    • SetOrderDeliveryItems.deliveryId input field type changed from String! to String
    • Input field deliveryKey was added to SetOrderDeliveryItems type

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
}