taxCategories

Query Tax Categories (per-country tax rates) with a `where` predicate and paging.

Use it in a workflow

Add a step and choose the Commercetools connector.
Pick the taxCategories action (under Tax).
Fill in the fields below, then reference the result from later steps as {{taxcategories.response.data}}.

Query

This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

query TaxCategories($where: String, $sort: [String!], $limit: Int, $offset: Int) {
  taxCategories(where: $where, sort: $sort, limit: $limit, offset: $offset) {
    offset
    count
    total
    exists
    results {
      name
      description
      rates {
        name
        amount
        includedInPrice
        country
        state
        id
        key
        subRates
      }
      key
      id
      version
      createdAt
      lastModifiedAt
      createdBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
      lastModifiedBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

wherestring

sortarray<string>

limitnumber

offsetnumber

json

{
  "where": "string",
  "sort": [
    "string"
  ],
  "limit": 0,
  "offset": 0
}

Response

Read the result with {{taxcategories.response.data.data.taxCategories}}. If the API returns errors, the step fails and they are at {{taxcategories.response.data.errors}}.

offsetnumber

countnumber

totalstring

existsboolean

resultsarray<object>

nameobject

descriptionobject

ratesobject

keyobject

idobject

versionobject

createdAtobject

lastModifiedAtobject

createdByobject

lastModifiedByobject

Need more? See the Commercetools guide for connection setup and behaviour shared by every action.

Was this page helpful?