Skip to main content

updateOrderFinancialInformation

Updates financial information for a V2 order.

This mutation allows updating financial status, shipping cost, and total tax 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
  • financial_status (optional): The financial status of the order
  • shipping_cost (optional): The shipping cost (must be non-negative)
  • total_tax (optional): The total tax (must be non-negative)
  • brand_id (optional): The brand ID (can be provided via X-Brand-Id header)

Validation​

  • Shipping cost and total tax cannot be negative
  • At least one field must be provided to update
updateOrderFinancialInformation(
  input: UpdateOrderFinancialInformationInput!
): V2Order!

Arguments​

updateOrderFinancialInformation.input ● UpdateOrderFinancialInformationInput! non-null input​

Parameters for UpdateOrderFinancialInformation

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.