customerDelete mutation

Version unstable

Deletes a customer.

Required access

write_customers access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
input ( CustomerDeleteInput! ) required

Specifies the customer to delete.

CustomerDeleteInput fields

  • id (ID!) Required

    The ID of the customer to delete.

Return fields

  • deletedCustomerId (ID)

    ID of the deleted customer.

  • shop (Shop!)

    Shop of the deleted customer.

  • userErrors ([UserError!]!)

    List of errors that occurred from executing the mutation.

Version 2021-10 (Release candidate)

Deletes a customer.

Required access

write_customers access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
input ( CustomerDeleteInput! ) required

Specifies the customer to delete.

CustomerDeleteInput fields

  • id (ID!) Required

    The ID of the customer to delete.

Return fields

  • deletedCustomerId (ID)

    ID of the deleted customer.

  • shop (Shop!)

    Shop of the deleted customer.

  • userErrors ([UserError!]!)

    List of errors that occurred from executing the mutation.

Version 2021-07 (Latest)

Deletes a customer.

Required