All Release Notes

Added additional support for Custom Fields on Custom Shipping Method update actions

18 December 2024
Composable Commerce
HTTP API
Enhancement
CartsOrdersGraphQL

You can now pass Custom Fields when using the Set Custom Shipping Method update actions on Carts and Order Edits. For Carts, use the Set Custom ShippingMethod action, and for Order Edits, use either the Set Custom ShippingMethod action or the Set ShippingAddress and Custom ShippingMethod action.

Changes:

  • [API] Added optional custom field to Set Custom ShippingMethod on Carts.

  • [API] Added optional custom field to Set Custom ShippingMethod and Set ShippingAddress and Custom ShippingMethod on Order Edits.

  • [GraphQL API] Changed the SetCartCustomShippingMethod type:

    • Input field custom was added to SetCartCustomShippingMethod type
  • [GraphQL API] Changed the SetStagedOrderCustomShippingMethod type:

    • Input field custom was added to SetStagedOrderCustomShippingMethod type
  • [GraphQL API] Changed the SetStagedOrderShippingAddressAndCustomShippingMethod type:

    • Input field custom was added to SetStagedOrderShippingAddressAndCustomShippingMethod type
  • [GraphQL API] Changed the SetStagedOrderShippingAddressAndCustomShippingMethodOutput type:

    • Added the custom field to the SetStagedOrderShippingAddressAndCustomShippingMethodOutput type
  • [GraphQL API] Changed the SetStagedOrderCustomShippingMethodOutput type:

    • Added the custom field to the SetStagedOrderCustomShippingMethodOutput type

The following changes were introduced in terms of GraphQL SDL:

extend type SetStagedOrderCustomShippingMethodOutput {
custom: CustomFieldsCommand
}
extend type SetStagedOrderShippingAddressAndCustomShippingMethodOutput {
custom: CustomFieldsCommand
}
extend input SetCartCustomShippingMethod {
custom: CustomFieldsDraft
}
extend input SetStagedOrderCustomShippingMethod {
custom: CustomFieldsDraft
}
extend input SetStagedOrderShippingAddressAndCustomShippingMethod {
custom: CustomFieldsDraft
}