Skip to main content

updateOrderCustomerInformation

Updates customer information for a V2 order.

This mutation allows updating shipping and billing addresses, names, emails, phones, and companies 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
  • shipping_address (optional): The shipping address
  • ship_to_name (optional): The shipping name
  • ship_to_email (optional): The shipping email
  • ship_to_phone (optional): The shipping phone
  • ship_to_company (optional): The shipping company
  • ship_to_same_as_bill_to (optional): Whether billing address is same as shipping
  • billing_address (optional): The billing address (required if ship_to_same_as_bill_to is false)
  • bill_to_name (optional): The billing name
  • bill_to_email (optional): The billing email
  • bill_to_phone (optional): The billing phone
  • bill_to_company (optional): The billing company
  • brand_id (optional): The brand ID (can be provided via X-Brand-Id header)

Validation​

  • Addresses must have address1, city, country, and postal_code
  • Postal codes are validated against country-specific formats
updateOrderCustomerInformation(
  input: UpdateOrderCustomerInformationInput!
): V2Order!

Arguments​

updateOrderCustomerInformation.input ● UpdateOrderCustomerInformationInput! non-null input​

Parameters for UpdateOrderCustomerInformation

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.