Support

Update an existing rate.

mutation

Requires commerce.tax:write.

Update an existing rate.

For SimpleMoneyInput.value, send 1999 for $19.99 USD, not 19.99.

Required headers

HeaderRequiredDescription
x-store-idYesID 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

  • id ID! required
  • input MutationUpdateRateInput! required
    • calculationMethod RateCalculationMethodEnum optional — The method to be used when applying the rate to a purchase amount.
    • createdAt DateTime optional — WARNING: DO NOT USE. Deprecated: This field is deprecated and only used for Tax v1 to v2 migration syncs.
    • description String optional — A human-friendly description.
    • jurisdictionId ID optional — The ID of the jurisdiction in which this rate applies.
    • label String optional — A label for display.
    • name String optional — A unique human-friendly identifier.
    • status RateStatusEnum optional — The desired status.
    • updatedAt DateTime optional — WARNING: DO NOT USE. Deprecated: This field is deprecated and only used for Tax v1 to v2 migration syncs.
    • value RateValueInput optional — The rate's value.
      • amount SimpleMoneyInput optional — The rate value represented as a fixed money amount. Required if percentage is not provided.
      • percentage String optional — The percentage applied by the rate, out of 100. Required if amount is not provided.

Possible returns

  • Rate Rate — An individual tax rate.

Last updated on

How is this guide?