bulkImportTaxGroups

Requires permission products:tax:import.

Imports tax groups from an uploaded file. It can validate the file without saving, and can update groups that already exist. Needs the tax import permission.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation BulkImportTaxGroups($input: BulkImportInput!) {
  bulkImportTaxGroups(input: $input) {
    failed
    success
    errors {
      taxGroupName
      errors
      row
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation BulkImportTaxGroups($input: BulkImportInput!) {\n  bulkImportTaxGroups(input: $input) {\n    failed\n    success\n    errors {\n      taxGroupName\n      errors\n      row\n    }\n  }\n}",
  "variables": {
    "input": {
      "fileContent": "string",
      "format": "CSV"
    }
  }
}
EOF

Variables:

{
  "input": {
    "fileContent": "string",
    "format": "CSV"
  }
}

Response:

{
  "data": {
    "bulkImportTaxGroups": {
      "failed": 0,
      "success": 0,
      "errors": [
        {
          "taxGroupName": "string",
          "errors": [
            "string"
          ],
          "row": 0
        }
      ]
    }
  }
}

bulkImportTaxGroups(
  input: BulkImportInput!
): TaxGroupBulkImportResult!

Arguments

bulkImportTaxGroups.input ● BulkImportInput! non-null input

The file content, its format, whether to only validate, and whether to update existing groups.

Type

TaxGroupBulkImportResult object

The outcome of a tax group import.