rates

query

Requires commerce.tax:read.

Get a collection of rates.

orderBy is one key only (id, name, createdAt, or updatedAt). Direction must be ASC or DESC. Sending two keys, or "desc", fails validation. value is a union. Select value { __typename ... on RatePercentage { percentage } ... on RateAmount { amount { value currencyCode } } }. There is no value { rate } field.

Required headers

Header	Required	Description
`x-store-id`	Yes	ID of the store the operation targets. Omitting it returns HTTP 200 with a GraphQL error: `extensions.code: "UNAUTHENTICATED"`.

Go to Authentication for credential setup.

Arguments

after String optional
before String optional
first Int optional
id RateIdFilter optional
- in [ID!] optional
last Int optional
orderBy RateOrderBy optional
- createdAt OrderByDirectionEnum optional
- id OrderByDirectionEnum optional
- name OrderByDirectionEnum optional
- updatedAt OrderByDirectionEnum optional
referenceValue ReferenceValueFilter optional
- in [String!] optional
status RateStatusFilter optional
- eq RateStatusEnum optional
- in [RateStatusEnum!] optional

Possible returns

QueryRatesConnection QueryRatesConnection

query GetRates($first: Int) {  rates(first: $first) {    edges {      node {        id        name        status        label        createdAt        updatedAt        value {          __typename          ... on RateAmount {            amount {              currencyCode              value            }          }          ... on RatePercentage {            percentage          }        }      }    }    pageInfo {      hasNextPage      endCursor      hasPreviousPage    }  }}

{  "data": {    "rates": {      "edges": [        {          "node": {            "id": "ID_VALUE",            "name": "Example",            "status": "ACTIVE",            "label": "Example",            "createdAt": "2026-01-15T12:00:00.000Z",            "updatedAt": "2026-01-15T12:00:00.000Z",            "value": {              "__typename": "RateAmount",              "amount": {                "currencyCode": "USD",                "value": 1999              }            }          }        }      ],      "pageInfo": {        "hasNextPage": false,        "endCursor": null,        "hasPreviousPage": false      }    }  }}

Last updated on