customerDelete mutation

Version 2020-01 (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

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 executing the mutation.

Version 2019-10 (Latest)

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

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 executing the mutation.

Version 2019-07

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

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 executing the mutation.

Version 2019-04

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

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 executing the mutation.

Sign up for a Partner account to get started.

Sign up