Surcharge

Surcharge entity representing additional fees and charges in the pricing system.

Contains comprehensive surcharge information including calculation rules, localized content, tax configuration, and validity periods. Used for dynamic pricing calculations and order processing.

type Surcharge {
  id: String!
  name: [LocalizedString!]!
  description: [LocalizedString!]
  type: SurchargeType!
  value: Float!
  taxCode: TaxCode!
  taxZone: String!
  enabled: Boolean!
  validFrom: DateTime
  validTo: DateTime
  createdBy: Int
  changedBy: Int
  dateCreated: DateTime!
  dateChanged: DateTime!
  shopId: Int
}

Fields

Surcharge.id ● String! non-null scalar

Unique identifier for the surcharge.

UUID format string that uniquely identifies this surcharge across the system.

Surcharge.name ● [LocalizedString!]! non-null object

Localized names for the surcharge in different languages.

Contains display names for the surcharge across multiple languages for internationalization support.

Surcharge.description ● [LocalizedString!] list object

Detailed descriptions of the surcharge in different languages.

Provides additional context about the surcharge purpose and application across multiple languages for internationalization support.

Surcharge.type ● SurchargeType! non-null enum

Classification of surcharge calculation method.

Determines how the surcharge value is applied to pricing calculations (flat fee or percentage-based).

Surcharge.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%).

Surcharge.taxCode ● TaxCode! non-null enum

Tax classification code that determines applicable tax rates and regulations.

Specifies the tax treatment for the surcharge (H for high rate, L for low rate, N for no tax).

Surcharge.taxZone ● String! non-null scalar

Geographic tax zone identifier for regional tax calculations.

Two-character code representing the tax jurisdiction for compliance and rate determination.

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

Surcharge.validFrom ● DateTime scalar

Start date and time for surcharge validity period.

Surcharge will only be applied to orders after this timestamp. If not set, surcharge is immediately active.

Surcharge.validTo ● DateTime scalar

End date and time for surcharge validity period.

Surcharge will not be applied to orders after this timestamp. If not set, surcharge remains active indefinitely.

Surcharge.createdBy ● Int scalar

Identifier of the user who created the surcharge.

References the user account responsible for creating this surcharge record.

Surcharge.changedBy ● Int scalar

Identifier of the user who last modified the surcharge.

References the user account responsible for the most recent changes to this surcharge record.

Surcharge.dateCreated ● DateTime! non-null scalar

Timestamp when the surcharge was created.

Automatically set when the surcharge record is first created in the system.

Surcharge.dateChanged ● DateTime! non-null scalar

Timestamp when the surcharge was last modified.

Automatically updated whenever the surcharge record is changed in the system.

Surcharge.shopId ● Int scalar

Shop identifier for surcharge application scope.

If not provided, the default shop will be inferred from the channel context.

Returned By

surcharge query ● surchargeCreate mutation ● surchargeDelete mutation ● surchargeUpdate mutation

Member Of

Product object ● SurchargeProduct object ● SurchargesResponse object