All Release Notes
Deliveries can now be extended with Custom Fields
20 December 2021
Composable Commerce
HTTP API
Enhancement
GraphQLOrdersExtensibility
You can now extend the Delivery object on the Order resource with Custom Fields. With these you can, for example, add meta data associated with your ERP system to the deliveries of the Orders.
Changes:
- [API] Added
custom
field to Delivery. - [API] Added update actions Set Delivery Custom Type and Set Delivery CustomField to the Order.
- [GraphQL API] Added the following types to the GraphQL schema:
SetOrderDeliveryCustomField
,SetOrderDeliveryCustomType
,SetStagedOrderDeliveryCustomField
,SetStagedOrderDeliveryCustomFieldOutput
,SetStagedOrderDeliveryCustomType
,SetStagedOrderDeliveryCustomTypeOutput
. - [GraphQL API] Changed the
AddOrderDelivery
type:- Input field
custom
was added toAddOrderDelivery
type
- Input field
- [GraphQL API] Changed the
Delivery
type:- Added the
custom
field to theDelivery
type.
- Added the
- [GraphQL API] Changed the
AddStagedOrderDelivery
type:- Input field
custom
was added toAddStagedOrderDelivery
type
- Input field
- [GraphQL API] Changed the
StagedOrderUpdateAction
type:- Input field
setDeliveryCustomField
was added toStagedOrderUpdateAction
type - Input field
setDeliveryCustomType
was added toStagedOrderUpdateAction
type
- Input field
- [GraphQL API] Changed the
AddStagedOrderDeliveryOutput
type:- Added the
custom
field to theAddStagedOrderDeliveryOutput
type.
- Added the
- [GraphQL API] Changed the
OrderUpdateAction
type:- Input field
setDeliveryCustomType
was added toOrderUpdateAction
type - Input field
setDeliveryCustomField
was added toOrderUpdateAction
type
- Input field
The following changes were introduced in terms of GraphQL SDL:
extend type Delivery {custom: CustomFieldsType}extend type AddStagedOrderDeliveryOutput {custom: CustomFieldsCommand}extend input AddOrderDelivery {custom: CustomFieldsDraft}extend input AddStagedOrderDelivery {custom: CustomFieldsDraft}extend input StagedOrderUpdateAction {setDeliveryCustomField: SetStagedOrderDeliveryCustomFieldsetDeliveryCustomType: SetStagedOrderDeliveryCustomType}extend input OrderUpdateAction {setDeliveryCustomField: SetOrderDeliveryCustomFieldsetDeliveryCustomType: SetOrderDeliveryCustomType}input SetOrderDeliveryCustomField {name: String!value: StringdeliveryId: String!}input SetOrderDeliveryCustomType {fields: [CustomFieldInput!]type: ResourceIdentifierInputtypeKey: StringtypeId: StringdeliveryId: String!}input SetStagedOrderDeliveryCustomField {name: String!value: StringdeliveryId: String!}type SetStagedOrderDeliveryCustomFieldOutput implements StagedOrderUpdateActionOutput {type: String!name: String!value: JsondeliveryId: String!}input SetStagedOrderDeliveryCustomType {fields: [CustomFieldInput!]type: ResourceIdentifierInputtypeKey: StringtypeId: StringdeliveryId: String!}type SetStagedOrderDeliveryCustomTypeOutput implements StagedOrderUpdateActionOutput {type: String!custom: CustomFieldsCommand!deliveryId: String!}