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 | |
partner_order_id | String | |
fulfillment_status | String | |
order_date | ISODateTime | |
total_tax | String | |
subtotal | String | DEPRECATED This field will be calculated by Shiphero |
total_discounts | String | |
total_price | String | DEPRECATED This field will be calculated by Shiphero |
box_name | String | |
ready_to_ship | Boolean | DEPRECATED This field is no longer being updated and should not be used or relied on |
insurance_amount | Decimal | |
required_ship_date | ISODateTime | |
allocation_priority | Int | |
shipping_lines | CreateShippingLinesInput | |
shipping_address | CreateOrderAddressInput | |
billing_address | CreateOrderAddressInput | |
profile | String | |
packing_note | String | |
note_attributes | [OrderNoteAttributeInput] | DEPRECATED Not used anymore. Use gift note |
tags | [String] | |
gift_note | String | |
gift_invoice | Boolean | |
require_signature | Boolean | |
adult_signature_required | Boolean | |
alcohol | Boolean | |
insurance | Boolean | |
allow_partial | Boolean | |
allow_split | Boolean | |
priority_flag | Boolean | |
hold_until_date | ISODateTime | |
incoterms | String | |
tax_id | String | |
tax_type | String | |
history_entry | UserNoteInput | |
ignore_address_validation_errors | Boolean | US addresses are be 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 | Not address validation will be performed |
custom_invoice_url | String | |
auto_print_return_label | Boolean | |
dry_ice_weight_in_lbs | String | |
ftr_exemption | Decimal | |
address_is_business | Boolean | |
tote_qa | Boolean | Requires users to scan and verify all items from a tote before shipping |
do_not_print_invoice | Boolean | |
ignore_payment_capture_errors | Boolean | |
partner_source_name | String | Partner source identifier (e.g., web, pos, shopify_draft_order, etc.) |
Referenced By
- order_update Mutation
Example
{
"customer_account_id": "abc123",
"order_id": "abc123",
"order_number": "abc123",
"partner_order_id": "abc123",
"fulfillment_status": "abc123",
"order_date": "abc123",
"total_tax": "abc123",
"subtotal": "abc123",
"total_discounts": "abc123",
"total_price": "abc123",
"box_name": "abc123",
"ready_to_ship": true,
"insurance_amount": "abc123",
"required_ship_date": "abc123",
"allocation_priority": 987,
"shipping_lines": CreateShippingLinesInput,
"shipping_address": CreateOrderAddressInput,
"billing_address": CreateOrderAddressInput,
"profile": "abc123",
"packing_note": "abc123",
"note_attributes": OrderNoteAttributeInput,
"tags": "abc123",
"gift_note": "abc123",
"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": "abc123",
"incoterms": "abc123",
"tax_id": "abc123",
"tax_type": "abc123",
"history_entry": UserNoteInput,
"ignore_address_validation_errors": true,
"skip_address_validation": true,
"custom_invoice_url": "abc123",
"auto_print_return_label": true,
"dry_ice_weight_in_lbs": "abc123",
"ftr_exemption": "abc123",
"address_is_business": true,
"tote_qa": true,
"do_not_print_invoice": true,
"ignore_payment_capture_errors": true,
"partner_source_name": "abc123"
}