Order Edit Remove Shipping Line Payload
Return type for mutation.
Anchor to FieldsFields
- calculatedOrder (CalculatedOrder)
- orderEditSession (OrderEditSession)
- userErrors ([OrderEditRemoveShippingLineUserError!]!)
- Anchor to calculatedOrdercalculated•Calculated
Order Order The calculated order with the edits applied but not saved.
Show fields
- Anchor to orderEditSessionorder•Order
Edit Session Edit Session The order edit session with the edits applied but not saved.
Show fields
- Anchor to userErrorsuser•[Order
Errors Edit Remove Shipping Line User Error!]! non-null The list of errors that occurred from executing the mutation.
Show fields
Anchor to Mutations with this payloadMutations with this payload
- orderEditRemoveShippingLine (OrderEditRemoveShippingLinePayload)
- •mutation
Removes a shipping line from an existing order. If the order has an existing write-off, mutations such as this one, which reduce the order total, can reduce the written-off amount automatically when the edit is committed and the order total before write-offs falls below the remaining written-off amount. For more information on how to use the GraphQL Admin API to edit an existing order, refer to Edit existing orders.
Show payload
- •ID!required
The ID of the calculated order or the order edit session to edit. This is the edit from which the shipping line is removed.
- Anchor to shippingLineIdshipping•ID!
Line Id required The ID of the calculated shipping line to remove.
Arguments
- •ID!