customerReplaceTaxExemptions

mutation

Requires write_customers access scope.

Replace tax exemptions for a customer.

Arguments

Anchor to customerIdcustomerId • ID!required: The ID of the customer to update.
Anchor to taxExemptionstaxExemptions • [TaxExemption!]!required: The list of tax exemptions that will replace the current exemptions for a customer. Can be an array or a comma-separated list. Example values: ["CA_BC_RESELLER_EXEMPTION", "A_STATUS_CARD_EXEMPTION"], "CA_BC_RESELLER_EXEMPTION, CA_STATUS_CARD_EXEMPTION".

Was this section helpful?

Anchor to CustomerReplaceTaxExemptionsPayload returnsCustomerReplaceTaxExemptionsPayload returns

Anchor to customercustomer • Customer: The updated customer.
Anchor to userErrorsuserErrors • [UserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Replace tax exemptions for a customer
customerReplaceTaxExemptions reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation customerReplaceTaxExemptions($customerId: ID!, $taxExemptions: [TaxExemption!]!) {
6    customerReplaceTaxExemptions(customerId: $customerId, taxExemptions: $taxExemptions) {
7      userErrors {
8        field
9        message
10      }
11      customer {
12        id
13        taxExemptions
14      }
15    }
16  }`,
17  {
18    variables: {
19      "customerId": "gid://shopify/Customer/554122808",
20      "taxExemptions": [
21        "CA_MB_COMMERCIAL_FISHERY_EXEMPTION",
22        "CA_ON_PURCHASE_EXEMPTION"
23      ]
24    },
25  },
26);
27
28const data = await response.json();
29

mutation customerReplaceTaxExemptions($customerId: ID!, $taxExemptions: [TaxExemption!]!) {
  customerReplaceTaxExemptions(customerId: $customerId, taxExemptions: $taxExemptions) {
    userErrors {
      field
      message
    }
    customer {
      id
      taxExemptions
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation customerReplaceTaxExemptions($customerId: ID!, $taxExemptions: [TaxExemption!]!) { customerReplaceTaxExemptions(customerId: $customerId, taxExemptions: $taxExemptions) { userErrors { field message } customer { id taxExemptions } } }",
 "variables": {
    "customerId": "gid://shopify/Customer/554122808",
    "taxExemptions": [
      "CA_MB_COMMERCIAL_FISHERY_EXEMPTION",
      "CA_ON_PURCHASE_EXEMPTION"
    ]
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation customerReplaceTaxExemptions($customerId: ID!, $taxExemptions: [TaxExemption!]!) {
    customerReplaceTaxExemptions(customerId: $customerId, taxExemptions: $taxExemptions) {
      userErrors {
        field
        message
      }
      customer {
        id
        taxExemptions
      }
    }
  }`,
  {
    variables: {
      "customerId": "gid://shopify/Customer/554122808",
      "taxExemptions": [
        "CA_MB_COMMERCIAL_FISHERY_EXEMPTION",
        "CA_ON_PURCHASE_EXEMPTION"
      ]
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation customerReplaceTaxExemptions($customerId: ID!, $taxExemptions: [TaxExemption!]!) {
      customerReplaceTaxExemptions(customerId: $customerId, taxExemptions: $taxExemptions) {
        userErrors {
          field
          message
        }
        customer {
          id
          taxExemptions
        }
      }
    }`,
    "variables": {
      "customerId": "gid://shopify/Customer/554122808",
      "taxExemptions": [
        "CA_MB_COMMERCIAL_FISHERY_EXEMPTION",
        "CA_ON_PURCHASE_EXEMPTION"
      ]
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation customerReplaceTaxExemptions($customerId: ID!, $taxExemptions: [TaxExemption!]!) {
    customerReplaceTaxExemptions(customerId: $customerId, taxExemptions: $taxExemptions) {
      userErrors {
        field
        message
      }
      customer {
        id
        taxExemptions
      }
    }
  }
QUERY

variables = {
  "customerId": "gid://shopify/Customer/554122808",
  "taxExemptions": ["CA_MB_COMMERCIAL_FISHERY_EXEMPTION", "CA_ON_PURCHASE_EXEMPTION"]
}

response = client.query(query: query, variables: variables)

Input variables

JSON

1{
2  "customerId": "gid://shopify/Customer/554122808",
3  "taxExemptions": [
4    "CA_MB_COMMERCIAL_FISHERY_EXEMPTION",
5    "CA_ON_PURCHASE_EXEMPTION"
6  ]
7}

Response

JSON

1{
2  "customerReplaceTaxExemptions": {
3    "userErrors": [],
4    "customer": {
5      "id": "gid://shopify/Customer/554122808",
6      "taxExemptions": [
7        "CA_MB_COMMERCIAL_FISHERY_EXEMPTION",
8        "CA_ON_PURCHASE_EXEMPTION"
9      ]
10    }
11  }
12}