Skip to main content

Interface: CreateSurchargeInput

Defined in: type/CreateSurchargeInput.ts:7

Input object for CreateSurchargeInput

Properties​

description?​

optional description?: LocalizedStringInput[]

Defined in: type/CreateSurchargeInput.ts:11

A brief description of the surcharge


enabled​

enabled: boolean

Defined in: type/CreateSurchargeInput.ts:21

Indicates whether the surcharge is active or not


name​

name: LocalizedStringInput[]

Defined in: type/CreateSurchargeInput.ts:9

A descriptive name for the surcharge


shopId?​

optional shopId?: number

Defined in: type/CreateSurchargeInput.ts:27

Shop identifier for the surcharge to apply to... If not provided the default will be inferred from the channel


taxCode​

taxCode: TaxCode

Defined in: type/CreateSurchargeInput.ts:17

Tax code


taxZone​

taxZone: string

Defined in: type/CreateSurchargeInput.ts:19

Tax zone


type​

type: SurchargeType

Defined in: type/CreateSurchargeInput.ts:13

Type of the surcharge


validFrom?​

optional validFrom?: string

Defined in: type/CreateSurchargeInput.ts:23

The date and time the surcharge is valid from


validTo?​

optional validTo?: string

Defined in: type/CreateSurchargeInput.ts:25

The date and time the surcharge is valid to


value​

value: number

Defined in: type/CreateSurchargeInput.ts:15

The value to be applied as surcharge (e.g., percentage or amount)