Skip to main content

UpdateSurchargeInput

Input data for updating an existing surcharge in the pricing system.

Contains partial surcharge information for updates. Only provided fields will be modified, others remain unchanged. All validation constraints must be satisfied for successful updates.

input UpdateSurchargeInput {
  name: [LocalizedStringInput!]
  description: [LocalizedStringInput!]
  type: SurchargeType
  value: Float
  taxCode: TaxCode
  taxCodeValue: Taxcode
  taxZone: String
  enabled: Boolean
  validFrom: String
  validTo: String
  shopId: Int
}

Fields​

UpdateSurchargeInput.name ● [LocalizedStringInput!] list input​

Localized names for the surcharge in different languages.

Must contain at least one language entry. Each entry requires a valid 2-character language code and corresponding name value. Used for display purposes across different locales.

UpdateSurchargeInput.description ● [LocalizedStringInput!] list input​

Detailed descriptions of the surcharge in different languages.

Provides additional context about the surcharge purpose and application. Each entry requires a valid 2-character language code and corresponding description value. Used for detailed information display.

UpdateSurchargeInput.type ● SurchargeType enum​

Classification of surcharge calculation method.

Determines how the surcharge value is applied to pricing calculations. Must be either flat fee for fixed amounts or percentage for proportional charges.

UpdateSurchargeInput.value ● Float scalar​

Numeric value for surcharge calculation.

For flat fees: amount in currency units. For percentages: percentage value (e.g., 15.5 for 15.5%). Must be a positive number.

UpdateSurchargeInput.taxCode ● TaxCode enum​

Tax code

UpdateSurchargeInput.taxCodeValue ● Taxcode enum​

Tax code value

UpdateSurchargeInput.taxZone ● String scalar​

Geographic tax zone identifier for regional tax calculations.

Must be exactly 2 characters representing the tax jurisdiction. Used to determine applicable tax rates and compliance requirements.

UpdateSurchargeInput.enabled ● Boolean scalar​

Activation status of the surcharge.

When true, the surcharge is active and will be applied to pricing calculations. When false, it is disabled and will not affect pricing.

UpdateSurchargeInput.validFrom ● String scalar​

Start date and time for surcharge validity period.

Surcharge will only be applied to orders after this timestamp. If not provided, surcharge is immediately active. Must be a valid ISO 8601 date string.

UpdateSurchargeInput.validTo ● String scalar​

End date and time for surcharge validity period.

Surcharge will not be applied to orders after this timestamp. If not provided, surcharge remains active indefinitely. Must be a valid ISO 8601 date string.

UpdateSurchargeInput.shopId ● Int scalar​

[DEPRECATED] Shop identifier for surcharge application scope.

If not provided, the default shop will be inferred from the channel context. Must be a positive integer representing a valid shop identifier.

Member Of​

surchargeUpdate mutation