Support

createOverride

View as Markdown

Create a new override.

mutation

Requires commerce.tax:create.

Create a new override.

metafields and references are optional — omit them. If you send metafields, the array must be nonempty; [] is rejected. Prefer type: "string" (lowercase).
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

  • input MutationCreateOverrideInput! required
    • label String! required — A label for display.
    • createdAt DateTime optional — WARNING: DO NOT USE. Deprecated: This field is deprecated and only used for Tax v1 to v2 migration syncs.
    • customRate OverrideCustomRateCreateInput 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.
    • metafields [CreateMetafieldInput!] optional — Any metafields to be created and assigned to the new override.
      • key String! required
      • namespace String! required
      • type String! required — Metafield value type. Prefer lowercase values such as string. Catalog rejects uppercase STRING; Tax currently accepts both.
      • value String! required
    • name String optional — A unique human-friendly identifier. If omitted, a name will be generated from the label value.
    • references [CreateReferenceInput!] optional — Any references to be created and assigned to the new override.
      • origin String! required — The origin of the reference.
      • value String! required — The value of the reference.
    • 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?