Skip to main content

CreateSurchargeInput

Input data for creating a new surcharge in the pricing system.

Contains all necessary information to establish a surcharge with calculation rules, localized content, and configuration settings. All validation constraints must be satisfied for successful creation.

input CreateSurchargeInput {
  name: [LocalizedStringInput!]!
  description: [LocalizedStringInput!]
  type: SurchargeType!
  value: Float!
  taxCodeValue: Taxcode
  taxZone: String!
  enabled: Boolean!
  validFrom: String
  validTo: String
}

Fields​

CreateSurchargeInput.name ● [LocalizedStringInput!]! non-null 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.

CreateSurchargeInput.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.

CreateSurchargeInput.type ● SurchargeType! non-null 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.

CreateSurchargeInput.value ● Float! non-null 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.

CreateSurchargeInput.taxCodeValue ● Taxcode enum​

Tax classification code that determines applicable tax rates and regulations.

Specifies the tax treatment for the surcharge. Must be one of the defined tax codes (H for high rate, L for low rate, N for no tax).

CreateSurchargeInput.taxZone ● String! non-null 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.

CreateSurchargeInput.enabled ● Boolean! non-null 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.

CreateSurchargeInput.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.

CreateSurchargeInput.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.

Member Of​

surchargeCreate mutation