input UpdateOrderFulfillmentStatusInput

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.
`fulfillment_status`	`String`!	Current fulfillment status; use the API status values returned by this field when filtering or updating.
`remove_inventory`	`Boolean`	Whether or not to remove inventory if the order is being cancelled.
`reason`	`String`	Human-readable reason for this order fulfillment status.
`cancel_on_platform`	`Boolean`	Only applies when fulfillment_status is exactly 'canceled'; supplying it for any other status, including 'cancelled', returns a validation error. Whether to also cancel the order on the connected sales platform. The order is always canceled in ShipHero regardless of this flag. Defaults to true when omitted. When set to false, the connected sales platform cancellation is skipped and void_on_platform is ignored.
`void_on_platform`	`Boolean`	Only applies when fulfillment_status is exactly 'canceled'; supplying it for any other status, including 'cancelled', returns a validation error. Shopify-only. Whether to attempt to reverse the order's payment on the sales platform when cancelling the order; ignored when cancel_on_platform is false. For Shopify orders, if the payment was authorized but not yet captured, the authorization is voided; if the payment was already captured, a refund is issued instead.

Referenced By

order_update_fulfillment_status Mutation

Example

{
  "customer_account_id": "QWNjb3VudDoxMjM0",
  "order_id": "T3JkZXI6MTIzNA==",
  "fulfillment_status": "pending",
  "remove_inventory": true,
  "reason": "pending",
  "cancel_on_platform": true,
  "void_on_platform": true
}