vendure/docs/content/graphql-api/shop/mutations.md

---

title: "Mutations" weight: 2 date: 2023-07-04T11:02:06.199Z showtoc: true

generated: true

Mutations

addItemToOrder

Adds an item to the order. If custom fields are defined on the OrderLine entity, a third argument 'customFields' will be available.

{{% gql-fields %}}

• addItemToOrder(productVariantId: ID!, quantity: Int!): UpdateOrderItemsResult! {{% /gql-fields %}}

addPaymentToOrder

Add a Payment to the Order

{{% gql-fields %}}

• addPaymentToOrder(input: PaymentInput!): AddPaymentToOrderResult! {{% /gql-fields %}}

adjustOrderLine

Adjusts an OrderLine. If custom fields are defined on the OrderLine entity, a third argument 'customFields' of type OrderLineCustomFieldsInput will be available.

{{% gql-fields %}}

• adjustOrderLine(orderLineId: ID!, quantity: Int!): UpdateOrderItemsResult! {{% /gql-fields %}}

applyCouponCode

Applies the given coupon code to the active Order

{{% gql-fields %}}

• applyCouponCode(couponCode: String!): ApplyCouponCodeResult! {{% /gql-fields %}}

authenticate

Authenticates the user using a named authentication strategy

{{% gql-fields %}}

• authenticate(input: AuthenticationInput!, rememberMe: Boolean): AuthenticationResult! {{% /gql-fields %}}

createCustomerAddress

Create a new Customer Address

{{% gql-fields %}}

• createCustomerAddress(input: CreateAddressInput!): Address! {{% /gql-fields %}}

deleteCustomerAddress

Delete an existing Address

{{% gql-fields %}}

• deleteCustomerAddress(id: ID!): Success! {{% /gql-fields %}}

login

Authenticates the user using the native authentication strategy. This mutation is an alias for authenticate({ native: { ... }})

{{% gql-fields %}}

• login(username: String!, password: String!, rememberMe: Boolean): NativeAuthenticationResult! {{% /gql-fields %}}

logout

End the current authenticated session

{{% gql-fields %}}

• logout: Success! {{% /gql-fields %}}

refreshCustomerVerification

Regenerate and send a verification token for a new Customer registration. Only applicable if authOptions.requireVerification is set to true.

{{% gql-fields %}}

• refreshCustomerVerification(emailAddress: String!): RefreshCustomerVerificationResult! {{% /gql-fields %}}

registerCustomerAccount

Register a Customer account with the given credentials. There are three possible registration flows:

If authOptions.requireVerification is set to true:

1. The Customer is registered with a password. A verificationToken will be created (and typically emailed to the Customer). That verificationToken would then be passed to the verifyCustomerAccount mutation without a password. The Customer is then verified and authenticated in one step.
2. The Customer is registered without a password. A verificationToken will be created (and typically emailed to the Customer). That verificationToken would then be passed to the verifyCustomerAccount mutation with the chosen password of the Customer. The Customer is then verified and authenticated in one step.

If authOptions.requireVerification is set to false:

1. The Customer must be registered with a password. No further action is needed - the Customer is able to authenticate immediately.

{{% gql-fields %}}

• registerCustomerAccount(input: RegisterCustomerInput!): RegisterCustomerAccountResult! {{% /gql-fields %}}

removeAllOrderLines

Remove all OrderLine from the Order

{{% gql-fields %}}

• removeAllOrderLines: RemoveOrderItemsResult! {{% /gql-fields %}}

removeCouponCode

Removes the given coupon code from the active Order

{{% gql-fields %}}

• removeCouponCode(couponCode: String!): Order {{% /gql-fields %}}

removeOrderLine

Remove an OrderLine from the Order

{{% gql-fields %}}

• removeOrderLine(orderLineId: ID!): RemoveOrderItemsResult! {{% /gql-fields %}}

requestPasswordReset

Requests a password reset email to be sent

{{% gql-fields %}}

• requestPasswordReset(emailAddress: String!): RequestPasswordResetResult {{% /gql-fields %}}

requestUpdateCustomerEmailAddress

Request to update the emailAddress of the active Customer. If authOptions.requireVerification is enabled (as is the default), then the identifierChangeToken will be assigned to the current User and a IdentifierChangeRequestEvent will be raised. This can then be used e.g. by the EmailPlugin to email that verification token to the Customer, which is then used to verify the change of email address.

{{% gql-fields %}}

• requestUpdateCustomerEmailAddress(password: String!, newEmailAddress: String!): RequestUpdateCustomerEmailAddressResult! {{% /gql-fields %}}

resetPassword

Resets a Customer's password based on the provided token

{{% gql-fields %}}

• resetPassword(token: String!, password: String!): ResetPasswordResult! {{% /gql-fields %}}

setCustomerForOrder

Set the Customer for the Order. Required only if the Customer is not currently logged in

{{% gql-fields %}}

• setCustomerForOrder(input: CreateCustomerInput!): SetCustomerForOrderResult! {{% /gql-fields %}}

setOrderBillingAddress

Sets the billing address for this order

{{% gql-fields %}}

• setOrderBillingAddress(input: CreateAddressInput!): ActiveOrderResult! {{% /gql-fields %}}

setOrderCustomFields

Allows any custom fields to be set for the active order

{{% gql-fields %}}

• setOrderCustomFields(input: UpdateOrderInput!): ActiveOrderResult! {{% /gql-fields %}}

setOrderShippingAddress

Sets the shipping address for this order

{{% gql-fields %}}

• setOrderShippingAddress(input: CreateAddressInput!): ActiveOrderResult! {{% /gql-fields %}}

setOrderShippingMethod

Sets the shipping method by id, which can be obtained with the eligibleShippingMethods query. An Order can have multiple shipping methods, in which case you can pass an array of ids. In this case, you should configure a custom ShippingLineAssignmentStrategy in order to know which OrderLines each shipping method will apply to.

{{% gql-fields %}}

• setOrderShippingMethod(shippingMethodId: [ID!]!): SetOrderShippingMethodResult! {{% /gql-fields %}}

transitionOrderToState

Transitions an Order to a new state. Valid next states can be found by querying nextOrderStates

{{% gql-fields %}}

• transitionOrderToState(state: String!): TransitionOrderToStateResult {{% /gql-fields %}}

updateCustomer

Update an existing Customer

{{% gql-fields %}}

• updateCustomer(input: UpdateCustomerInput!): Customer! {{% /gql-fields %}}

updateCustomerAddress

Update an existing Address

{{% gql-fields %}}

• updateCustomerAddress(input: UpdateAddressInput!): Address! {{% /gql-fields %}}

updateCustomerEmailAddress

Confirm the update of the emailAddress with the provided token, which has been generated by the requestUpdateCustomerEmailAddress mutation.

{{% gql-fields %}}

• updateCustomerEmailAddress(token: String!): UpdateCustomerEmailAddressResult! {{% /gql-fields %}}

updateCustomerPassword

Update the password of the active Customer

{{% gql-fields %}}

• updateCustomerPassword(currentPassword: String!, newPassword: String!): UpdateCustomerPasswordResult! {{% /gql-fields %}}

verifyCustomerAccount

Verify a Customer email address with the token sent to that address. Only applicable if authOptions.requireVerification is set to true.

If the Customer was not registered with a password in the registerCustomerAccount mutation, the password must be provided here.

{{% gql-fields %}}

• verifyCustomerAccount(token: String!, password: String): VerifyCustomerAccountResult! {{% /gql-fields %}}