updateRate
View as MarkdownUpdate 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
| 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
idID!requiredinputMutationUpdateRateInput!requiredcalculationMethodRateCalculationMethodEnumoptional — The method to be used when applying the rate to a purchase amount.createdAtDateTimeoptional — WARNING: DO NOT USE. Deprecated: This field is deprecated and only used for Tax v1 to v2 migration syncs.descriptionStringoptional — A human-friendly description.jurisdictionIdIDoptional — The ID of the jurisdiction in which this rate applies.labelStringoptional — A label for display.nameStringoptional — A unique human-friendly identifier.statusRateStatusEnumoptional — The desired status.updatedAtDateTimeoptional — WARNING: DO NOT USE. Deprecated: This field is deprecated and only used for Tax v1 to v2 migration syncs.valueRateValueInputoptional — The rate's value.amountSimpleMoneyInputoptional — The rate value represented as a fixed money amount. Required ifpercentageis not provided.percentageStringoptional — The percentage applied by the rate, out of 100. Required ifamountis not provided.
Possible returns
RateRate— An individual tax rate.
Last updated on
How is this guide?