Anchor to section titled 'undefined'

customerAddTaxExemptions
mutation

Requires write_customers access scope. Also: User needs customer permissions.

Add tax exemptions for the customer.


Anchor to customerId
customerId
required

The ID of the customer to update.

The list of tax exemptions to add for the customer, in the format of an array or a comma-separated list. Example values: ["CA_BC_RESELLER_EXEMPTION", "CA_STATUS_CARD_EXEMPTION"], "CA_BC_RESELLER_EXEMPTION, CA_STATUS_CARD_EXEMPTION".


Was this section helpful?

The updated customer.

The list of errors that occurred from executing the mutation.


Was this section helpful?

Examples

Hide code
Copy
mutation customerAddTaxExemptions($customerId: ID!, $taxExemptions: [TaxExemption!]!) {
  customerAddTaxExemptions(customerId: $customerId, taxExemptions: $taxExemptions) {
    userErrors {
      field
      message
    }
    customer {
      id
    }
  }
}
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation customerAddTaxExemptions($customerId: ID!, $taxExemptions: [TaxExemption!]!) { customerAddTaxExemptions(customerId: $customerId, taxExemptions: $taxExemptions) { userErrors { field message } customer { id } } }",
 "variables": {
    "customerId": "gid://shopify/Customer/839649557",
    "taxExemptions": [
      "CA_BC_RESELLER_EXEMPTION",
      "CA_STATUS_CARD_EXEMPTION"
    ]
  }
}'
const { admin } = await authenticate.admin(request);

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

const data = await response.json();
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 customerAddTaxExemptions($customerId: ID!, $taxExemptions: [TaxExemption!]!) {
    customerAddTaxExemptions(customerId: $customerId, taxExemptions: $taxExemptions) {
      userErrors {
        field
        message
      }
      customer {
        id
      }
    }
  }
QUERY

variables = {
  "customerId": "gid://shopify/Customer/839649557",
  "taxExemptions": ["CA_BC_RESELLER_EXEMPTION", "CA_STATUS_CARD_EXEMPTION"]
}

response = client.query(query: query, variables: variables)
const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation customerAddTaxExemptions($customerId: ID!, $taxExemptions: [TaxExemption!]!) {
      customerAddTaxExemptions(customerId: $customerId, taxExemptions: $taxExemptions) {
        userErrors {
          field
          message
        }
        customer {
          id
        }
      }
    }`,
    "variables": {
      "customerId": "gid://shopify/Customer/839649557",
      "taxExemptions": [
        "CA_BC_RESELLER_EXEMPTION",
        "CA_STATUS_CARD_EXEMPTION"
      ]
    },
  },
});
use Shopify\Clients\Graphql;

$client = new Graphql("your-development-store.myshopify.com", $accessToken);
$query = <<<QUERY
  mutation customerAddTaxExemptions($customerId: ID!, $taxExemptions: [TaxExemption!]!) {
    customerAddTaxExemptions(customerId: $customerId, taxExemptions: $taxExemptions) {
      userErrors {
        field
        message
      }
      customer {
        id
      }
    }
  }
QUERY;

$variables = [
  "customerId" => "gid://shopify/Customer/839649557",
  "taxExemptions" => ["CA_BC_RESELLER_EXEMPTION", "CA_STATUS_CARD_EXEMPTION"],
];

$response = $client->query(["query" => $query, "variables" => $variables]);
Hide code
Input variables
Copy
{
  "customerId": "gid://shopify/Customer/839649557",
  "taxExemptions": [
    "CA_BC_RESELLER_EXEMPTION",
    "CA_STATUS_CARD_EXEMPTION"
  ]
}
Hide code
Response
JSON
{
  "customerAddTaxExemptions": {
    "userErrors": [],
    "customer": {
      "id": "gid://shopify/Customer/839649557"
    }
  }
}