Skip to main content

updateOrderGiftMessage

Updates gift message for a V2 order.

This mutation allows updating the gift message for orders in draft, pending, or accepted states.

Requirements​

  • User must have update_order permission
  • Valid brand context must be provided (via argument or X-Brand-Id header)
  • Order must exist and be using the V2 aggregate (internal_version = "v2")
  • Order must be in draft, pending, or accepted state

Arguments​

  • order_id (required): The ID of the order to update
  • gift_message (optional): The gift message (can be set to null to clear)
  • brand_id (optional): The brand ID (can be provided via X-Brand-Id header)
updateOrderGiftMessage(
  input: UpdateOrderGiftMessageInput!
): V2Order!

Arguments​

updateOrderGiftMessage.input ● UpdateOrderGiftMessageInput! non-null input​

Parameters for UpdateOrderGiftMessage

Type​

V2Order object​

The V2 order type. This type represents a V2 order in the system with only the fields necessary for draft creation and details.