customerReplaceTaxExemptions - admin-graphql - MUTATION

Version: 2024-10

Description:

Replace tax exemptions for a customer.

Access Scopes

`write_customers` access scope.

Arguments

• customerId: ID! - The ID of the customer to update.
• taxExemptions: TaxExemption! - 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"`.

Returns

• customer: Customer The updated customer.
• userErrors: UserError! The list of errors that occurred from executing the mutation.

Examples

• Replace tax exemptions for a customer

          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"
          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"
          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"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"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"
          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"
          Graphql 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}"
        

  input: {
    "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"
          ]
        }
      }
    }
  }