Skip to main content

Retrieve settings

GET 
/configurator/:version/configurator/settings

Settings that can be applied to the configurator such as theme preferences

Request​

Path Parameters

    version stringrequired

Query Parameters

    lang string

    (Optional) Language ISO

Responses​

Success

Schema

    id uuid
    organizationId uuidnullable
    reference stringnullable
    synced boolean
    createdDate date-time
    updatedDate date-time
    domain stringnullable
    requireLogin boolean
    primaryColor stringnullable
    primaryFontColor stringnullable
    accentColor stringnullable
    accentFontColor stringnullable
    fontFamily stringnullable
    faviconUrl stringnullable
    enableWelcomePage boolean
    enableProductPage boolean
    enableOverviewPage boolean
    enableMultipleConfigurations boolean
    productSelectionBackgroundUrl stringnullable
    welcomeBackgroundUrl stringnullable
    welcomeYoutubeId stringnullable

    welcomeTexts

    object[]

    nullable

  • Array [

    • id uuid
    organizationId uuidnullable
    reference stringnullable
    synced boolean
    createdDate date-time
    updatedDate date-time
    value stringnullable
    languageIso stringnullable

    Possible values: <= 3 characters

    settingsId uuidnullable
    showroomSettingsId uuidnullable

  • ]

    • languages

    object[]

    nullable

  • Array [

    • iso stringnullable
    name stringnullable
    active boolean
    englishName stringnullable

  • ]

    • countries

    object[]

    nullable

  • Array [

    • iso stringnullable
    name stringnullable
    active boolean
    englishName stringnullable
    phonePrefix stringnullable
    capital stringnullable

  • ]

    • displayVat boolean
    logoUrl stringnullable
    mandatoryCrmValues stringnullable
    mandatoryCrmContactValues stringnullable
    quotationRequestRedirectUrl stringnullable
    quotationRequestedAction int32

    Possible values: [0, 1]

    DisplayThankYouPopup, RedirectTo

    allowDifferentShipToAddress boolean
    requiredQuotationFields string[]nullable
    customCss stringnullable
    privacyPolicyAppendixIFrame stringnullable
    enable3dFootprint boolean
    enable3dLabel boolean
    displayCreateQuotationInLastStep boolean
    displayedShowroomCrmFields string[]nullable
    googleAnalyticsCode stringnullabledeprecated
    googleTagManagerContainerId stringnullable

    Possible values: <= 12 characters

    afterOrderTexts

    object[]

    nullable

  • Array [

    • id uuid
    organizationId uuidnullable
    reference stringnullable
    synced boolean
    createdDate date-time
    updatedDate date-time
    value stringnullable
    languageIso stringnullable

    Possible values: <= 3 characters

    settingsId uuidnullable
    showroomSettingsId uuidnullable

  • ]

    • attachPdfToMail boolean
    sendMailToCustomer boolean

    quotationCustomMailTexts

    object[]

    nullable

  • Array [

    • id uuid
    organizationId uuidnullable
    reference stringnullable
    synced boolean
    createdDate date-time
    updatedDate date-time
    subject stringnullable
    value stringnullable
    languageIso stringnullable

    Possible values: <= 3 characters

    settingsId uuidnullable
    showroomSettingsId uuidnullable

  • ]

    • defaultVatId uuidnullable

    defaultVat

    object

    id uuid
    organizationId uuidnullable
    reference stringnullable
    synced boolean
    createdDate date-time
    updatedDate date-time
    name stringnullable
    pct double
    pctString stringnullable
    includesVAT boolean
    defaultVat boolean
    coefficient double
    currencyIso stringnullable
    enableCustomFeatureModelSettings boolean

    showroomFeatureModelSettings

    object[]

    nullable

  • Array [

    • id uuid
    organizationId uuidnullable
    reference stringnullable
    synced boolean
    createdDate date-time
    updatedDate date-time
    showroomSettingsId uuid
    featureModelId uuid
    allowedToSell boolean
    displayPrices boolean

  • ]

    • hideCustomerField boolean
    hideDeliveryDateField boolean
    hideRemarksField boolean
    hideShippingAddressField boolean
    checkoutQuotationPropertyIds string[]nullable
    defaultCulture stringnullable

    Possible values: <= 10 characters

    sendQuotationRequestMail stringnullable
    onConfigurationLeavePopup boolean
    productPageDefaultPageSize int32
    hasCustomerPortalEnabled boolean
    selectedLanguageIso stringnullable
    afterOrderText stringnullable
    allowGroupAmount boolean
Loading...