customerAddTaxExemptions
mutation

Choose a version:

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

Add tax exemptions for the customer.

Anchor to section titled 'Arguments'

Arguments

Anchor to customerId customerId ID! required: The ID of the customer to update.
Anchor to taxExemptions taxExemptions [TaxExemption!]! required: 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?

Anchor to section titled 'CustomerAddTaxExemptionsPayload returns'

CustomerAddTaxExemptionsPayload returns

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

Was this section helpful?

Code examples for MUTATION: customerAddTaxExemptions

Query Reference for MUTATION: customerAddTaxExemptions

"mutation customerAddTaxExemptions($customerId: ID!, $taxExemptions: [TaxExemption!]!) {\n  customerAddTaxExemptions(customerId: $customerId, taxExemptions: $taxExemptions) {\n    customer {\n      # Customer fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: customerAddTaxExemptions

"{\n  \"customerId\": \"gid://shopify/<objectName>/10079785100\",\n  \"taxExemptions\": [\n    \"CA_BC_COMMERCIAL_FISHERY_EXEMPTION\"\n  ]\n}"

Schema Reference for MUTATION: customerAddTaxExemptions

""

Display Examples for MUTATION: customerAddTaxExemptions

[
  {
    "example": {
      "type_name": "customeraddtaxexemptions",
      "title": "Add tax exemptions for a customer",
      "query_string": "mutation customerAddTaxExemptions($customerId: ID!, $taxExemptions: [TaxExemption!]!) {\n  customerAddTaxExemptions(customerId: $customerId, taxExemptions: $taxExemptions) {\n    userErrors {\n      field\n      message\n    }\n    customer {\n      id\n    }\n  }\n}",
      "variables": {
        "customerId": "gid://shopify/Customer/839649557",
        "taxExemptions": [
          "CA_BC_RESELLER_EXEMPTION",
          "CA_STATUS_CARD_EXEMPTION"
        ]
      },
      "response": {
        "data": {
          "customerAddTaxExemptions": {
            "userErrors": [],
            "customer": {
              "id": "gid://shopify/Customer/839649557"
            }
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/taxes/test/unit/graph_api/admin/mutations/customer_add_tax_exemptions_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation customerAddTaxExemptions($customerId: ID!, $taxExemptions: [TaxExemption!]!) { customerAddTaxExemptions(customerId: $customerId, taxExemptions: $taxExemptions) { userErrors { field message } customer { id } } }\",\n \"variables\": {\n    \"customerId\": \"gid://shopify/Customer/839649557\",\n    \"taxExemptions\": [\n      \"CA_BC_RESELLER_EXEMPTION\",\n      \"CA_STATUS_CARD_EXEMPTION\"\n    ]\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation customerAddTaxExemptions($customerId: ID!, $taxExemptions: [TaxExemption!]!) {\n    customerAddTaxExemptions(customerId: $customerId, taxExemptions: $taxExemptions) {\n      userErrors {\n        field\n        message\n      }\n      customer {\n        id\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"customerId\": \"gid://shopify/Customer/839649557\",\n      \"taxExemptions\": [\n        \"CA_BC_RESELLER_EXEMPTION\",\n        \"CA_STATUS_CARD_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 customerAddTaxExemptions($customerId: ID!, $taxExemptions: [TaxExemption!]!) {\n    customerAddTaxExemptions(customerId: $customerId, taxExemptions: $taxExemptions) {\n      userErrors {\n        field\n        message\n      }\n      customer {\n        id\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"customerId\": \"gid://shopify/Customer/839649557\",\n  \"taxExemptions\": [\"CA_BC_RESELLER_EXEMPTION\", \"CA_STATUS_CARD_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 customerAddTaxExemptions($customerId: ID!, $taxExemptions: [TaxExemption!]!) {\n      customerAddTaxExemptions(customerId: $customerId, taxExemptions: $taxExemptions) {\n        userErrors {\n          field\n          message\n        }\n        customer {\n          id\n        }\n      }\n    }`,\n    \"variables\": {\n      \"customerId\": \"gid://shopify/Customer/839649557\",\n      \"taxExemptions\": [\n        \"CA_BC_RESELLER_EXEMPTION\",\n        \"CA_STATUS_CARD_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 customerAddTaxExemptions($customerId: ID!, $taxExemptions: [TaxExemption!]!) {\n    customerAddTaxExemptions(customerId: $customerId, taxExemptions: $taxExemptions) {\n      userErrors {\n        field\n        message\n      }\n      customer {\n        id\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"customerId\" => \"gid://shopify/Customer/839649557\",\n  \"taxExemptions\" => [\"CA_BC_RESELLER_EXEMPTION\", \"CA_STATUS_CARD_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/839649557\"",
        "typeKind": "MUTATION"
      },
      {
        "arg": {
          "name": "taxExemptions",
          "description": "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\"`.",
          "type": {
            "kind": "ENUM",
            "name": "TaxExemption",
            "list": true,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "[TaxExemption!]!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "taxExemptions",
        "argValue": " [\"CA_BC_RESELLER_EXEMPTION\",\"CA_STATUS_CARD_EXEMPTION\"]",
        "typeKind": "MUTATION"
      }
    ]
  }
]

customerAddTaxExemptionsmutation

Arguments

CustomerAddTaxExemptionsPayload returns

customerAddTaxExemptions
mutation