Skip to main content
View Markdown

ShopSettingsInput Input Type

No description

input ShopSettingsInput {
  name: String
  headerText: String
  description: String
  trackInventoryByDefault: Boolean
  defaultWeightUnit: WeightUnitsEnum
  fulfillmentAutoApprove: Boolean
  fulfillmentAllowUnpaid: Boolean
  defaultMailSenderName: String
  defaultMailSenderAddress: String
  customerSetPasswordUrl: String
  reserveStockDurationAnonymousUser: Int
  reserveStockDurationAuthenticatedUser: Int
  limitQuantityPerCheckout: Int
  enableAccountConfirmationByEmail: Boolean
  allowLoginWithoutConfirmation: Boolean
  allowStorefrontTraffic: Boolean
  metadata: [MetadataInput!]
  privateMetadata: [MetadataInput!]
  preserveAllAddressFields: Boolean
  passwordLoginMode: PasswordLoginModeEnum
  useLegacyShippingZoneStockAvailability: Boolean
  includeTaxesInPrices: Boolean @deprecated
  displayGrossPrices: Boolean @deprecated
  chargeTaxesOnShipping: Boolean @deprecated
  useLegacyUpdateWebhookEmission: Boolean @deprecated
  accountConfirmMergeMode: AccountConfirmModeEnum
}

Fields​

name ● String​

Shop's name.

Added in Saleor 3.23

headerText ● String​

Header text.

description ● String​

SEO description.

trackInventoryByDefault ● Boolean​

This field is used as a default value for ProductVariant.trackInventory.

defaultWeightUnit ● WeightUnitsEnum​

Default weight unit.

fulfillmentAutoApprove ● Boolean​

Enable automatic approval of all new fulfillments.

fulfillmentAllowUnpaid ● Boolean​

Enable ability to approve fulfillments which are unpaid.

defaultMailSenderName ● String​

Default email sender's name.

defaultMailSenderAddress ● String​

Default email sender's address.

customerSetPasswordUrl ● String​

URL of a view where customers can set their password.

reserveStockDurationAnonymousUser ● Int​

Default number of minutes stock will be reserved for anonymous checkout. Enter 0 or null to disable.

reserveStockDurationAuthenticatedUser ● Int​

Default number of minutes stock will be reserved for authenticated checkout. Enter 0 or null to disable.

limitQuantityPerCheckout ● Int​

Default number of maximum line quantity in single checkout. Minimum possible value is 1, default value is 50.

enableAccountConfirmationByEmail ● Boolean​

Enable automatic account confirmation by email.

allowLoginWithoutConfirmation ● Boolean​

Enable possibility to login without account confirmation.

allowStorefrontTraffic ● Boolean​

Determines whether the GraphQL API accepts storefront requests (anonymous requests and authenticated non-staff customers). When disabled, only apps and staff users may call the API directly; all other requests are rejected with an HTTP 401 and the STOREFRONT_TRAFFIC_NOT_ALLOWED error code.

Added in Saleor 3.23

metadata ● [MetadataInput!]​

Shop public metadata. Can be read by any API client authorized to read the object it's attached to.

Warning: never store sensitive information, including financial data such as credit card details.

privateMetadata ● [MetadataInput!]​

Shop private metadata. Requires permissions to modify and to read the metadata of the object it's attached to.

Warning: never store sensitive information, including financial data such as credit card details.

preserveAllAddressFields ● Boolean​

When enabled, address fields that are not valid for a given country (according to Google's i18n address data) will be preserved instead of being removed during validation. Validation errors are still returned.

Added in Saleor 3.22

passwordLoginMode ● PasswordLoginModeEnum​

Controls whether password-based authentication is allowed.

Added in Saleor 3.23

useLegacyShippingZoneStockAvailability ● Boolean​

When enabled, stock availability is filtered by shipping zones and the destination address (legacy behavior). When disabled, stock availability is determined only by the direct warehouse-channel link, ignoring shipping zones.

Added in Saleor 3.23

accountConfirmMergeMode ● AccountConfirmModeEnum​

Controls the method used for merging existing orders and giftcards when password-based authentication is used. Learn more at https://docs.saleor.io/upgrade-guides/core/migrate-account-merging

Show deprecatedHide deprecated

includeTaxesInPrices ● Boolean​

DEPRECATED

Use taxConfigurationUpdate mutation to configure this setting per channel or country.

Include taxes in prices.

displayGrossPrices ● Boolean​

DEPRECATED

Use taxConfigurationUpdate mutation to configure this setting per channel or country.

Display prices with tax in store.

chargeTaxesOnShipping ● Boolean​

DEPRECATED

To enable taxes for a shipping method, assign a tax class to the shipping method with shippingPriceCreate or shippingPriceUpdate mutations.

Charge taxes on shipping.

useLegacyUpdateWebhookEmission ● Boolean​

DEPRECATED

No longer supported

Use legacy update webhook emission. When enabled, update webhooks (e.g. customerUpdated,productVariantUpdated) are sent even when only metadata changes. When disabled, update webhooks are not sent for metadata-only changes; only metadata-specific webhooks (e.g., customerMetadataUpdated, productVariantMetadataUpdated) are sent.

Added in Saleor 3.22

Member Of​

shopSettingsUpdate mutation