Enumeration ShopperCustomersMutations

Mutations available for Shopper Customers.

Enumeration Members

CreateCustomerAddress: "createCustomerAddress"

Creates a new address with the given name for the given customer.

Returns

A TanStack Query mutation hook for interacting with the Shopper Customers createCustomerAddress endpoint.

CreateCustomerPaymentInstrument: "createCustomerPaymentInstrument"

Adds a payment instrument to the customer information.

Returns

A TanStack Query mutation hook for interacting with the Shopper Customers createCustomerPaymentInstrument endpoint.

CreateCustomerProductList: "createCustomerProductList"

Creates a customer product list.

Returns

A TanStack Query mutation hook for interacting with the Shopper Customers createCustomerProductList endpoint.

CreateCustomerProductListItem: "createCustomerProductListItem"

Returns

A TanStack Query mutation hook for interacting with the Shopper Customers createCustomerProductListItem endpoint.

DeleteCustomerPaymentInstrument: "deleteCustomerPaymentInstrument"

Deletes a customer's payment instrument.

Returns

A TanStack Query mutation hook for interacting with the Shopper Customers deleteCustomerPaymentInstrument endpoint.

DeleteCustomerProductList: "deleteCustomerProductList"

Deletes a customer product list.

Returns

A TanStack Query mutation hook for interacting with the Shopper Customers deleteCustomerProductList endpoint.

DeleteCustomerProductListItem: "deleteCustomerProductListItem"

Removes an item from a customer product list.

Returns

A TanStack Query mutation hook for interacting with the Shopper Customers deleteCustomerProductListItem endpoint.

GetResetPasswordToken: "getResetPasswordToken"

Get reset password token. This is the first step in the reset customer password flow, where a password reset token is requested for future use to reset a customer password. This call should be followed by a call to the /reset endpoint.

Returns

A TanStack Query mutation hook for interacting with the Shopper Customers getResetPasswordToken endpoint.

RegisterCustomer: "registerCustomer"

Registers a new customer. The mandatory data are the credentials, profile last name, and email. This requires a JSON Web Token (JWT) which needs to be obtained using the POST /customers/auth API with type "guest".

Returns

A TanStack Query mutation hook for interacting with the Shopper Customers registerCustomer endpoint.

RemoveCustomerAddress: "removeCustomerAddress"

Deletes a customer's address by address name.

Returns

A TanStack Query mutation hook for interacting with the Shopper Customers removeCustomerAddress endpoint.

ResetPassword: "resetPassword"

Reset customer password, after obtaining a reset token. This is the second step in the reset customer password flow, where a customer password is reset by providing the new credentials along with a reset token. This call should be preceded by a call to the /create-reset-token endpoint.

Returns

A TanStack Query mutation hook for interacting with the Shopper Customers resetPassword endpoint.

UpdateCustomer: "updateCustomer"

Updates a customer.

Returns

A TanStack Query mutation hook for interacting with the Shopper Customers updateCustomer endpoint.

UpdateCustomerAddress: "updateCustomerAddress"

Updates a customer's address by address name.

Returns

A TanStack Query mutation hook for interacting with the Shopper Customers updateCustomerAddress endpoint.

UpdateCustomerPassword: "updateCustomerPassword"

Updates the customer's password.

Returns

A TanStack Query mutation hook for interacting with the Shopper Customers updateCustomerPassword endpoint.

UpdateCustomerProductList: "updateCustomerProductList"

Changes a product list. Changeable properties are the name, description, and if the list is public.

Returns

A TanStack Query mutation hook for interacting with the Shopper Customers updateCustomerProductList endpoint.

UpdateCustomerProductListItem: "updateCustomerProductListItem"

Updates an item of a customer's product list.