updateOverride
View as MarkdownUpdate an existing override.
mutation
Requires commerce.tax:write.
Update an existing override.
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!requiredinputMutationUpdateOverrideInput!requiredcreatedAtDateTimeoptional — WARNING: DO NOT USE. Deprecated: This field is deprecated and only used for Tax v1 to v2 migration syncs.customRateOverrideCustomRateUpdateInputoptional — A custom rate to be applied by the override.valueRateValueInput!required — The custom rate's value.calculationMethodOverrideCalculationMethodEnumoptional — The method to be used when applying the custom rate to a purchase amount.
descriptionStringoptional — A human-friendly description.labelStringoptional — A label for display.nameStringoptional — A unique human-friendly identifier.statusOverrideStatusEnumoptional — The desired status.targetRateIdIDoptional — The ID of the target rate that this override references.updatedAtDateTimeoptional — WARNING: DO NOT USE. Deprecated: This field is deprecated and only used for Tax v1 to v2 migration syncs.
Possible returns
OverrideOverride— A rule to override any other taxation criteria for the associated skus, groups, or lists.
Last updated on
How is this guide?