Skip to main content

updateFulfillmentAdditionalData

Replaces the free-form additional data JSON blob on a fulfillment.

Business Rules​

  • **Replace semantics**: the previous value is overwritten in full; partial merges are not supported.
  • **Clearing**: pass null (or omit additionalData) to clear all stored data.
  • **State guard**: cannot be applied to fulfillments in shipped or cancelled state.

Error Scenarios​

  • **NOT_FOUND**: the order or fulfillment does not exist.
  • **UNPROCESSABLE_ENTITY**: the fulfillment is shipped or cancelled.
  • **UNAUTHORIZED**: missing required permissions or invalid company access.

Permissions Required​

  • orders:update_fulfillment_additional_data permission
updateFulfillmentAdditionalData(
  input: UpdateFulfillmentAdditionalDataInput!
): OrderFulfillment!

Arguments​

updateFulfillmentAdditionalData.input ● UpdateFulfillmentAdditionalDataInput! non-null input common​

Parameters for UpdateFulfillmentAdditionalData

Type​

OrderFulfillment object orders​

This type represents an order fulfillment. An order can have multiple fulfillments, each one associated with a warehouse and a party that fulfilled the order.