Support

updateOverride

View as Markdown

Update 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

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 MutationUpdateOverrideInput! required
    • createdAt DateTime optional — WARNING: DO NOT USE. Deprecated: This field is deprecated and only used for Tax v1 to v2 migration syncs.
    • customRate OverrideCustomRateUpdateInput optional — A custom rate to be applied by the override.
      • value RateValueInput! required — The custom rate's value.
      • calculationMethod OverrideCalculationMethodEnum optional — The method to be used when applying the custom rate to a purchase amount.
    • description String optional — A human-friendly description.
    • label String optional — A label for display.
    • name String optional — A unique human-friendly identifier.
    • status OverrideStatusEnum optional — The desired status.
    • targetRateId ID optional — The ID of the target rate that this override references.
    • updatedAt DateTime optional — WARNING: DO NOT USE. Deprecated: This field is deprecated and only used for Tax v1 to v2 migration syncs.

Possible returns

  • Override Override — A rule to override any other taxation criteria for the associated skus, groups, or lists.

Last updated on

How is this guide?