createOverride
View as MarkdownCreate 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
| 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
inputMutationCreateOverrideInput!requiredlabelString!required — A label for display.createdAtDateTimeoptional — WARNING: DO NOT USE. Deprecated: This field is deprecated and only used for Tax v1 to v2 migration syncs.customRateOverrideCustomRateCreateInputoptional — 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.metafields[CreateMetafieldInput!]optional — Any metafields to be created and assigned to the new override.keyString!requirednamespaceString!requiredtypeString!required — Metafield value type. Prefer lowercase values such asstring. Catalog rejects uppercaseSTRING; Tax currently accepts both.valueString!required
nameStringoptional — A unique human-friendly identifier. If omitted, a name will be generated from thelabelvalue.references[CreateReferenceInput!]optional — Any references to be created and assigned to the new override.originString!required — The origin of the reference.valueString!required — The value of the reference.
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?