Skip to main content

UpdateOrderInput

Changes to the header of an order created through the API. Every omitted field keeps its current value. Line items are changed with addOrderLineItem, updateOrderLineItem and removeOrderLineItem, custom fields with setOrderCustomFields.

input UpdateOrderInput {
id: ID!
billingAddress: OrderAddressInput
shippingAddress: OrderAddressInput
shippingMethodId: ID
shippingCosts: OrderShippingCostsInput
customerComment: String
}

Fields​

UpdateOrderInput.id ● ID! non-null scalar​

ID of the order to change.

UpdateOrderInput.billingAddress ● OrderAddressInput input​

New billing address. Replaces the current one as a whole. When the order ships to its billing address, the shipping address stays as it is.

UpdateOrderInput.shippingAddress ● OrderAddressInput input​

New shipping address. Replaces the current one as a whole. When the order ships to its billing address, the billing address stays as it is.

UpdateOrderInput.shippingMethodId ● ID scalar​

ID of the new shipping method of the order's delivery.

UpdateOrderInput.shippingCosts ● OrderShippingCostsInput input​

New shipping costs, read in the order's tax status. The order totals are derived again from the line items and these shipping costs; the amount of the order's payment stays as it is.

UpdateOrderInput.customerComment ● String scalar​

New comment of the customer on the order. Pass an empty string to remove the comment.

Member Of​

updateOrder mutation