Anchor to section titled 'undefined'

marketRegionsDelete
mutation

Requires read_markets for queries and both read_markets as well as write_markets for mutations.

Deletes a list of market regions.

Anchor to section titled 'Arguments'

Arguments

Anchor to ids
ids
[ID!]!
required

A list of IDs of the market regions to delete.

Was this section helpful?
Anchor to section titled 'MarketRegionsDeletePayload returns'

MarketRegionsDeletePayload returns

Anchor to MarketRegionsDeletePayload.deletedIds
deletedIds
[ID!]

The ID of the deleted market region.

Anchor to MarketRegionsDeletePayload.userErrors
userErrors
[MarketUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation marketRegionsDelete($ids: [ID!]!) {
  marketRegionsDelete(ids: $ids) {
    deletedIds
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "ids": [
    "gid://shopify/<objectName>/10079785100"
  ]
}