Add new entity to Settings

POST 
/Settings

Add new entity to Settings

Request

application/json

Body

required

New entity

primaryColor string
nextQuotationNumber int32

Possible values: >= -2147483648 and <= 2147483647

quotationNumberFormat string
lastQuotationDateTime date-time
quotationNumberResetPeriod
accentColor string
customCss string
customCssEms string
crmAccountId uuid
logoUrl string
lightLogoUrl string
homeImageUrl string
faviconUrl string
primaryFontColor string
accentFontColor string
fontFamily string
disableConflictDialog boolean
disableConflictDialogOrderEntry boolean
featureModelVersioning boolean
enableArticleCodeInEditor boolean
quotationExpiresInDays int32

Possible values: >= -2147483648 and <= 2147483647

sendQuotationRequestMail string
sendMailToCustomer boolean
allowGroupAmount boolean
requireLogin boolean
defaultVatId uuid
displayVatPrices boolean
quotationRequestedAction
quotationRequestRedirectUrl string
divergentFeatureModelNodePrices boolean
mandatoryCrmValues string
mandatoryCrmContactValues string
privacyPolicyAppendixIFrame string
disableFullOverview boolean
requireTermsAndConditions boolean
disableTablePresetEditing boolean
disableImageCropping boolean
autoArchiveQuotations boolean
defaultArchivedStatusId uuid
defaultRevisedStatusId uuid
defaultExpiredStatusId uuid
enableConfigurator boolean
enableMultipleConfigurations boolean
enableWelcomePage boolean
enableOverviewPage boolean
welcomePageBackgroundUrl string
welcomePageYouTubeId string
loginPageBackgroundUrl string
productSelectionPageBackgroundUrl string
disableProductSelection boolean
map3DToNodes boolean
enable3dFootprint boolean
enable3dLabel boolean
allowDifferentShipToAddress boolean
hideCustomerFieldInShowroom boolean
hideDeliveryDateFieldInShowroom boolean
hideRemarksFieldInShowroom boolean
hideShippingAddressFieldInShowroom boolean
displayCreateQuotationInLastStep boolean
requiredQuotationFields string[]
hiddenQuotationFields string[]
disabledQuotationFields string[]
checkoutQuotationPropertyIds string[]
displayedShowroomCrmFields string[]
quotationActionsPerStatus undefined[]
currencyDeterminationMethod
id uuid
createdDate date-time
updatedDate date-time
organizationId uuid
reference string
creatorId uuid
customField1 string
customField2 string
customField3 string
customField4 string
customField5 string
organization

Responses

201

Created entity

application/json

Schema

Schema

primaryColor string
nextQuotationNumber int32

Possible values: >= -2147483648 and <= 2147483647

quotationNumberFormat string
lastQuotationDateTime date-time
quotationNumberResetPeriod
accentColor string
customCss string
customCssEms string
crmAccountId uuid
logoUrl string
lightLogoUrl string
homeImageUrl string
faviconUrl string
primaryFontColor string
accentFontColor string
fontFamily string
disableConflictDialog boolean
disableConflictDialogOrderEntry boolean
featureModelVersioning boolean
enableArticleCodeInEditor boolean
quotationExpiresInDays int32

Possible values: >= -2147483648 and <= 2147483647

sendQuotationRequestMail string
sendMailToCustomer boolean
allowGroupAmount boolean
requireLogin boolean
defaultVatId uuid
displayVatPrices boolean
quotationRequestedAction
quotationRequestRedirectUrl string
divergentFeatureModelNodePrices boolean
mandatoryCrmValues string
mandatoryCrmContactValues string
privacyPolicyAppendixIFrame string
disableFullOverview boolean
requireTermsAndConditions boolean
disableTablePresetEditing boolean
disableImageCropping boolean
autoArchiveQuotations boolean
defaultArchivedStatusId uuid
defaultRevisedStatusId uuid
defaultExpiredStatusId uuid
enableConfigurator boolean
enableMultipleConfigurations boolean
enableWelcomePage boolean
enableOverviewPage boolean
welcomePageBackgroundUrl string
welcomePageYouTubeId string
loginPageBackgroundUrl string
productSelectionPageBackgroundUrl string
disableProductSelection boolean
map3DToNodes boolean
enable3dFootprint boolean
enable3dLabel boolean
allowDifferentShipToAddress boolean
hideCustomerFieldInShowroom boolean
hideDeliveryDateFieldInShowroom boolean
hideRemarksFieldInShowroom boolean
hideShippingAddressFieldInShowroom boolean
displayCreateQuotationInLastStep boolean
requiredQuotationFields string[]
hiddenQuotationFields string[]
disabledQuotationFields string[]
checkoutQuotationPropertyIds string[]
displayedShowroomCrmFields string[]
quotationActionsPerStatus undefined[]
currencyDeterminationMethod
id uuid
createdDate date-time
updatedDate date-time
organizationId uuid
reference string
creatorId uuid
customField1 string
customField2 string
customField3 string
customField4 string
customField5 string
organization

Example (from schema)

{
  "primaryColor": "string",
  "nextQuotationNumber": 0,
  "quotationNumberFormat": "string",
  "lastQuotationDateTime": "2024-06-06T15:30:37.707Z",
  "quotationNumberResetPeriod": {},
  "accentColor": "string",
  "customCss": "string",
  "customCssEms": "string",
  "crmAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "logoUrl": "string",
  "lightLogoUrl": "string",
  "homeImageUrl": "string",
  "faviconUrl": "string",
  "primaryFontColor": "string",
  "accentFontColor": "string",
  "fontFamily": "string",
  "disableConflictDialog": true,
  "disableConflictDialogOrderEntry": true,
  "featureModelVersioning": true,
  "enableArticleCodeInEditor": true,
  "quotationExpiresInDays": 0,
  "sendQuotationRequestMail": "string",
  "sendMailToCustomer": true,
  "allowGroupAmount": true,
  "requireLogin": true,
  "defaultVatId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "displayVatPrices": true,
  "quotationRequestedAction": {},
  "quotationRequestRedirectUrl": "string",
  "divergentFeatureModelNodePrices": true,
  "mandatoryCrmValues": "string",
  "mandatoryCrmContactValues": "string",
  "privacyPolicyAppendixIFrame": "string",
  "disableFullOverview": true,
  "requireTermsAndConditions": true,
  "disableTablePresetEditing": true,
  "disableImageCropping": true,
  "autoArchiveQuotations": true,
  "defaultArchivedStatusId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "defaultRevisedStatusId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "defaultExpiredStatusId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enableConfigurator": true,
  "enableMultipleConfigurations": true,
  "enableWelcomePage": true,
  "enableOverviewPage": true,
  "welcomePageBackgroundUrl": "string",
  "welcomePageYouTubeId": "string",
  "loginPageBackgroundUrl": "string",
  "productSelectionPageBackgroundUrl": "string",
  "disableProductSelection": true,
  "map3DToNodes": true,
  "enable3dFootprint": true,
  "enable3dLabel": true,
  "allowDifferentShipToAddress": true,
  "hideCustomerFieldInShowroom": true,
  "hideDeliveryDateFieldInShowroom": true,
  "hideRemarksFieldInShowroom": true,
  "hideShippingAddressFieldInShowroom": true,
  "displayCreateQuotationInLastStep": true,
  "requiredQuotationFields": [
    "string"
  ],
  "hiddenQuotationFields": [
    "string"
  ],
  "disabledQuotationFields": [
    "string"
  ],
  "checkoutQuotationPropertyIds": [
    "string"
  ],
  "displayedShowroomCrmFields": [
    "string"
  ],
  "quotationActionsPerStatus": [
    null
  ],
  "currencyDeterminationMethod": {},
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdDate": "2024-06-06T15:30:37.708Z",
  "updatedDate": "2024-06-06T15:30:37.708Z",
  "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reference": "string",
  "creatorId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "customField1": "string",
  "customField2": "string",
  "customField3": "string",
  "customField4": "string",
  "customField5": "string",
  "organization": {}
}

default

error

application/json

Schema

Schema

error

object

required

code stringrequired

message stringrequired

target string

details

object[]

Array [

code stringrequired

message stringrequired

target string

]

innererror object

The structure of this object is service-specific

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      {
        "code": "string",
        "message": "string",
        "target": "string"
      }
    ],
    "innererror": {}
  }
}

Loading...