customer Replace Tax Exemptionsmutation
Requires write
access scope. Also: User needs customer permissions.
Replace tax exemptions for a customer.
Arguments
The ID of the customer to update.
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:
["C
,A _B C _R E S E L L E R _E X E M P T I O N", "A _S T A T U S _C A R D _E X E M P T I O N"] "C
.A _B C _R E S E L L E R _E X E M P T I O N, C A _S T A T U S _C A R D _E X E M P T I O N"
CustomerReplaceTaxExemptionsPayload returns
The updated customer.
The list of errors that occurred from executing the mutation.
Code examples for MUTATION: customerReplaceTaxExemptions
Query Reference for MUTATION: customerReplaceTaxExemptions
"mutation customerReplaceTaxExemptions($customerId: ID!, $taxExemptions: [TaxExemption!]!) {\n customerReplaceTaxExemptions(customerId: $customerId, taxExemptions: $taxExemptions) {\n customer {\n # Customer fields\n }\n userErrors {\n field\n message\n }\n }\n}"
Input Reference for MUTATION: customerReplaceTaxExemptions
"{\n \"customerId\": \"gid://shopify/<objectName>/10079785100\",\n \"taxExemptions\": [\n \"CA_BC_COMMERCIAL_FISHERY_EXEMPTION\"\n ]\n}"
Schema Reference for MUTATION: customerReplaceTaxExemptions
""
Display Examples for MUTATION: customerReplaceTaxExemptions
[ { "example": { "type_name": "customerreplacetaxexemptions", "title": "Replace tax exemptions for a customer", "query_string": "mutation customerReplaceTaxExemptions($customerId: ID!, $taxExemptions: [TaxExemption!]!) {\n customerReplaceTaxExemptions(customerId: $customerId, taxExemptions: $taxExemptions) {\n userErrors {\n field\n message\n }\n customer {\n id\n taxExemptions\n }\n }\n}", "variables": { "customerId": "gid://shopify/Customer/554122808", "taxExemptions": [ "CA_MB_COMMERCIAL_FISHERY_EXEMPTION", "CA_ON_PURCHASE_EXEMPTION" ] }, "response": { "data": { "customerReplaceTaxExemptions": { "userErrors": [], "customer": { "id": "gid://shopify/Customer/554122808", "taxExemptions": [ "CA_MB_COMMERCIAL_FISHERY_EXEMPTION", "CA_ON_PURCHASE_EXEMPTION" ] } } } }, "api_name": "admin", "minimum_api_version": "2023-10", "maximum_api_version": "unstable", "location": "/components/taxes/test/unit/graph_api/admin/mutations/customer_replace_tax_exemptions_test.rb", "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation customerReplaceTaxExemptions($customerId: ID!, $taxExemptions: [TaxExemption!]!) { customerReplaceTaxExemptions(customerId: $customerId, taxExemptions: $taxExemptions) { userErrors { field message } customer { id taxExemptions } } }\",\n \"variables\": {\n \"customerId\": \"gid://shopify/Customer/554122808\",\n \"taxExemptions\": [\n \"CA_MB_COMMERCIAL_FISHERY_EXEMPTION\",\n \"CA_ON_PURCHASE_EXEMPTION\"\n ]\n }\n}'\n", "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation customerReplaceTaxExemptions($customerId: ID!, $taxExemptions: [TaxExemption!]!) {\n customerReplaceTaxExemptions(customerId: $customerId, taxExemptions: $taxExemptions) {\n userErrors {\n field\n message\n }\n customer {\n id\n taxExemptions\n }\n }\n }`,\n {\n variables: {\n \"customerId\": \"gid://shopify/Customer/554122808\",\n \"taxExemptions\": [\n \"CA_MB_COMMERCIAL_FISHERY_EXEMPTION\",\n \"CA_ON_PURCHASE_EXEMPTION\"\n ]\n },\n },\n);\n\nconst data = await response.json();\n", "ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation customerReplaceTaxExemptions($customerId: ID!, $taxExemptions: [TaxExemption!]!) {\n customerReplaceTaxExemptions(customerId: $customerId, taxExemptions: $taxExemptions) {\n userErrors {\n field\n message\n }\n customer {\n id\n taxExemptions\n }\n }\n }\nQUERY\n\nvariables = {\n \"customerId\": \"gid://shopify/Customer/554122808\",\n \"taxExemptions\": [\"CA_MB_COMMERCIAL_FISHERY_EXEMPTION\", \"CA_ON_PURCHASE_EXEMPTION\"]\n}\n\nresponse = client.query(query: query, variables: variables)\n", "node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation customerReplaceTaxExemptions($customerId: ID!, $taxExemptions: [TaxExemption!]!) {\n customerReplaceTaxExemptions(customerId: $customerId, taxExemptions: $taxExemptions) {\n userErrors {\n field\n message\n }\n customer {\n id\n taxExemptions\n }\n }\n }`,\n \"variables\": {\n \"customerId\": \"gid://shopify/Customer/554122808\",\n \"taxExemptions\": [\n \"CA_MB_COMMERCIAL_FISHERY_EXEMPTION\",\n \"CA_ON_PURCHASE_EXEMPTION\"\n ]\n },\n },\n});\n", "php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation customerReplaceTaxExemptions($customerId: ID!, $taxExemptions: [TaxExemption!]!) {\n customerReplaceTaxExemptions(customerId: $customerId, taxExemptions: $taxExemptions) {\n userErrors {\n field\n message\n }\n customer {\n id\n taxExemptions\n }\n }\n }\nQUERY;\n\n$variables = [\n \"customerId\" => \"gid://shopify/Customer/554122808\",\n \"taxExemptions\" => [\"CA_MB_COMMERCIAL_FISHERY_EXEMPTION\", \"CA_ON_PURCHASE_EXEMPTION\"],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n" }, "titleStringKey": "variables", "inputVariableEntries": [ { "arg": { "name": "customerId", "description": "The ID of the customer to update.", "type": { "kind": "SCALAR", "name": "ID", "list": false, "non_null": true }, "defaultValue": null, "typeSignature": "ID!", "isDeprecated": false, "deprecationReason": null, "kind": "ARGUMENT" }, "key": "customerId", "argValue": " \"gid://shopify/Customer/554122808\"", "typeKind": "MUTATION" }, { "arg": { "name": "taxExemptions", "description": "The list of tax exemptions that will replace the current exemptions for a customer. Can be an array or a comma-separated list.\n Example values: `[\"CA_BC_RESELLER_EXEMPTION\", \"A_STATUS_CARD_EXEMPTION\"]`, `\"CA_BC_RESELLER_EXEMPTION, CA_STATUS_CARD_EXEMPTION\"`.", "type": { "kind": "ENUM", "name": "TaxExemption", "list": true, "non_null": true }, "defaultValue": null, "typeSignature": "[TaxExemption!]!", "isDeprecated": false, "deprecationReason": null, "kind": "ARGUMENT" }, "key": "taxExemptions", "argValue": " [\"CA_MB_COMMERCIAL_FISHERY_EXEMPTION\",\"CA_ON_PURCHASE_EXEMPTION\"]", "typeKind": "MUTATION" } ] } ]