Anchor to section titled 'undefined'

marketRegionDelete
mutation

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

Deletes a market region.

Anchor to section titled 'Arguments'

Arguments

Anchor to id
id
ID!
required

The ID of the market region to delete.

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

MarketRegionDeletePayload returns

Anchor to MarketRegionDeletePayload.deletedId
deletedId
ID

The ID of the deleted market region.

Anchor to MarketRegionDeletePayload.market
market
Market

The parent market object of the deleted region.

Anchor to MarketRegionDeletePayload.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 marketRegionDelete($id: ID!) {
  marketRegionDelete(id: $id) {
    deletedId
    market {
      # Market fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "id": "gid://shopify/<objectName>/10079785100"
}