input UpdateOrderInput

Fields

Field	Type	Description
`customer_account_id`	`String`	Use this when you are a 3PL acting on behalf of one of your customers.
`order_id`	`String`!	The id of the order you want to modify.
`order_number`	`String`	Order number for this order.
`partner_order_id`	`String`	Partner order ID from the external store or upstream system.
`fulfillment_status`	`String`	Current fulfillment status; use the API status values returned by this field when filtering or updating.
`order_date`	ISODateTime	Order date in ISO-8601 date or datetime format, returned in UTC when time is included.
`total_tax`	`String`	Monetary amount as a decimal value in the record currency; not cents.
`subtotal`	`String`	DEPRECATED This field will be calculated by Shiphero Customer-facing charge amount as a decimal monetary value in the order currency; distinct from value/customs_value used for declared value. Deprecated; see the deprecation reason for current behavior.
`total_discounts`	`String`	Monetary amount as a decimal value in the record currency; not cents.
`total_price`	`String`	DEPRECATED This field will be calculated by Shiphero Customer-facing charge amount as a decimal monetary value in the order currency; distinct from value/customs_value used for declared value. Deprecated; see the deprecation reason for current behavior.
`box_name`	`String`	Box name for this order.
`ready_to_ship`	`Boolean`	DEPRECATED This field is no longer being updated and should not be used or relied on Deprecated ready-to-ship flag; this field is no longer updated reliably.
`insurance_amount`	Decimal	Monetary amount as a decimal value in the record currency; not cents.
`required_ship_date`	ISODateTime	Required ship date in ISO-8601 date or datetime format, returned in UTC when time is included.
`allocation_priority`	`Int`	Allocation priority as a numeric value.
`shipping_lines`	CreateShippingLinesInput	Shipping lines for this order.
`shipping_address`	CreateOrderAddressInput	Shipping address details for this order.
`billing_address`	CreateOrderAddressInput	Billing address details for this order.
`profile`	`String`	Profile for this order.
`packing_note`	`String`	Packing note for this order.
`note_attributes`	[OrderNoteAttributeInput]	DEPRECATED Not used anymore. Use gift note Legacy name/value note attributes; ignored in favor of gift_note where deprecated.
`tags`	[`String`]	List of tags for this order.
`gift_note`	`String`	Gift note for this order.
`gift_invoice`	`Boolean`	Whether this order should use a gift invoice.
`require_signature`	`Boolean`	Whether this order requires a delivery signature.
`adult_signature_required`	`Boolean`	Whether this order requires an adult delivery signature.
`alcohol`	`Boolean`	Whether this order contains alcohol and requires alcohol shipping handling.
`insurance`	`Boolean`	Whether shipping insurance is enabled for this order.
`allow_partial`	`Boolean`	True when this order allows partial; false otherwise.
`allow_split`	`Boolean`	True when this order allows split; false otherwise.
`priority_flag`	`Boolean`	Whether this order is marked as priority.
`hold_until_date`	ISODateTime	Hold until date in ISO-8601 date or datetime format, returned in UTC when time is included.
`incoterms`	`String`	Incoterms for this order.
`tax_id`	`String`	Public API tax ID that identifies the related record.
`tax_type`	`String`	Tax type for this order.
`history_entry`	UserNoteInput	History entry for this order.
`ignore_address_validation_errors`	`Boolean`	US addresses are validated and when errors occur the order will have an address hold created. If this flag is set then the error validation is skipped and no address hold is created.
`skip_address_validation`	`Boolean`	When true, address validation is skipped for this order.
`custom_invoice_url`	`String`	URL for the custom invoice URL resource.
`auto_print_return_label`	`Boolean`	Whether a return label should be printed automatically for this order.
`dry_ice_weight_in_lbs`	`String`	Dry ice weight in lb in pounds.
`ftr_exemption`	Decimal	Foreign Trade Regulations exemption value. Deprecated; use ftr_exemption_value.
`address_is_business`	`Boolean`	Whether the ship-to address is a business address.
`tote_qa`	`Boolean`	Requires users to scan and verify all items from a tote before shipping.
`do_not_print_invoice`	`Boolean`	Whether invoices should be suppressed when printing documents for this order.
`ignore_payment_capture_errors`	`Boolean`	Whether to ignore payment capture errors for this order.
`service_point_id`	`String`	Public API service point ID that identifies the related record.
`partner_source_name`	`String`	Partner source identifier (e.g., web, pos, shopify_draft_order, etc.).

Referenced By

order_update Mutation

Example

{
  "customer_account_id": "QWNjb3VudDoxMjM0",
  "order_id": "T3JkZXI6MTIzNA==",
  "order_number": "SO-100045",
  "partner_order_id": "SHOPIFY-100045",
  "fulfillment_status": "pending",
  "order_date": "2026-07-09T15:30:00Z",
  "total_tax": "19.99",
  "subtotal": "19.99",
  "total_discounts": "19.99",
  "total_price": "19.99",
  "box_name": "SO-100045",
  "ready_to_ship": true,
  "insurance_amount": 19.99,
  "required_ship_date": "2026-07-09T15:30:00Z",
  "allocation_priority": 1,
  "shipping_lines": {title: "Standard Shipping", price: "5.99"},
  "shipping_address": {address1: "123 Fulfillment Ave", city: "New York", country: "US"},
  "billing_address": {address1: "123 Billing St", city: "New York", country: "US"},
  "profile": "default",
  "packing_note": "Customer requested expedited handling.",
  "note_attributes": [[{id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"}]],
  "tags": ["priority", "vip"],
  "gift_note": "Customer requested expedited handling.",
  "gift_invoice": true,
  "require_signature": true,
  "adult_signature_required": true,
  "alcohol": true,
  "insurance": true,
  "allow_partial": true,
  "allow_split": true,
  "priority_flag": true,
  "hold_until_date": "2026-07-09T15:30:00Z",
  "incoterms": "DAP",
  "tax_id": "UmVjb3JkOjEyMzQ=",
  "tax_type": "19.99",
  "history_entry": {source: "api", message: "Customer requested expedited handling."},
  "ignore_address_validation_errors": false,
  "skip_address_validation": false,
  "custom_invoice_url": "https://example.com/resource",
  "auto_print_return_label": true,
  "dry_ice_weight_in_lbs": "1.25",
  "ftr_exemption": 1.5,
  "address_is_business": true,
  "tote_qa": true,
  "do_not_print_invoice": false,
  "ignore_payment_capture_errors": false,
  "service_point_id": "UHVyY2hhc2VPcmRlcjoxMjM0",
  "partner_source_name": "shopify"
}