Shop

Represents a shop resource containing general shop data and configuration.

type Shop implements ObjectWithMetadata {
  privateMetadata: [MetadataItem!]!
  privateMetafield(key: String!): String
  privateMetafields(keys: [String!]): Metadata
  metadata: [MetadataItem!]!
  metafield(key: String!): String
  metafields(keys: [String!]): Metadata
  id: ID!
  availablePaymentGateways(
    currency: String
    channel: String
  ): [PaymentGateway!]!
  availableExternalAuthentications: [ExternalAuthentication!]!
  availableShippingMethods(
    channel: String!
    address: AddressInput
  ): [ShippingMethod!]
  channelCurrencies: [String!]!
  countries(
    languageCode: LanguageCodeEnum
    filter: CountryFilterInput
  ): [CountryDisplay!]!
  defaultCountry: CountryDisplay
  defaultMailSenderName: String
  defaultMailSenderAddress: String
  description: String
  domain: Domain!
  languages: [LanguageDisplay!]!
  name: String!
  permissions: [Permission!]!
  phonePrefixes: [String!]!
  headerText: String
  fulfillmentAutoApprove: Boolean!
  fulfillmentAllowUnpaid: Boolean!
  trackInventoryByDefault: Boolean
  defaultWeightUnit: WeightUnitsEnum
  translation(languageCode: LanguageCodeEnum!): ShopTranslation
  automaticFulfillmentDigitalProducts: Boolean
  reserveStockDurationAnonymousUser: Int
  reserveStockDurationAuthenticatedUser: Int
  limitQuantityPerCheckout: Int
  defaultDigitalMaxDownloads: Int
  defaultDigitalUrlValidDays: Int
  companyAddress: Address
  customerSetPasswordUrl: String
  staffNotificationRecipients: [StaffNotificationRecipient!]
  enableAccountConfirmationByEmail: Boolean
  allowLoginWithoutConfirmation: Boolean
  limits: LimitInfo!
  version: String!
  schemaVersion: String!
  includeTaxesInPrices: Boolean! @deprecated
  displayGrossPrices: Boolean! @deprecated
  chargeTaxesOnShipping: Boolean! @deprecated
}

Expand ▼

Fields

Shop.privateMetadata ● [MetadataItem!]! non-null object

List of private metadata items. Requires staff permissions to access.

Shop.privateMetafield ● String scalar

A single key from private metadata. Requires staff permissions to access.

Tip: Use GraphQL aliases to fetch multiple keys.

Shop.privateMetafield.key ● String! non-null scalar

Shop.privateMetafields ● Metadata scalar

Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.

Shop.privateMetafields.keys ● [String!] list scalar

Shop.metadata ● [MetadataItem!]! non-null object

List of public metadata items. Can be accessed without permissions.

Shop.metafield ● String scalar

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Shop.metafield.key ● String! non-null scalar

Shop.metafields ● Metadata scalar

Public metadata. Use keys to control which fields you want to include. The default is to include everything.

Shop.metafields.keys ● [String!] list scalar

Shop.id ● ID! non-null scalar

ID of the shop.

Shop.availablePaymentGateways ● [PaymentGateway!]! non-null object

List of available payment gateways.

Shop.availablePaymentGateways.currency ● String scalar

A currency for which gateways will be returned.

DEPRECATED: this field will be removed in Saleor 4.0. Use channel argument instead.

Shop.availablePaymentGateways.channel ● String scalar

Slug of a channel for which the data should be returned.

Shop.availableExternalAuthentications ● [ExternalAuthentication!]! non-null object

List of available external authentications.

Shop.availableShippingMethods ● [ShippingMethod!] list object

Shipping methods that are available for the shop.

Shop.availableShippingMethods.channel ● String! non-null scalar

Slug of a channel for which the data should be returned.

Shop.availableShippingMethods.address ● AddressInput input

Address for which available shipping methods should be returned.

Shop.channelCurrencies ● [String!]! non-null scalar

List of all currencies supported by shop's channels.

Added in Saleor 3.1

Requires one of the following permissions: AUTHENTICATED_STAFF_USERAUTHENTICATED_APP

Shop.countries ● [CountryDisplay!]! non-null object

List of countries available in the shop.

Shop.countries.languageCode ● LanguageCodeEnum enum

A language code to return the translation for.

DEPRECATED: this field will be removed in Saleor 4.0.

Shop.countries.filter ● CountryFilterInput input

Filtering options for countries

Shop.defaultCountry ● CountryDisplay object

Shop's default country.

Shop.defaultMailSenderName ● String scalar

Default shop's email sender's name.

Requires MANAGE_SETTINGSpermission.

Shop.defaultMailSenderAddress ● String scalar

Default shop's email sender's address.

Requires MANAGE_SETTINGSpermission.

Shop.description ● String scalar

Shop's description.

Shop.domain ● Domain! non-null object

Shop's domain data.

Shop.languages ● [LanguageDisplay!]! non-null object

List of the shops's supported languages.

Shop.name ● String! non-null scalar

Shop's name.

Shop.permissions ● [Permission!]! non-null object

List of available permissions.

Shop.phonePrefixes ● [String!]! non-null scalar

List of possible phone prefixes.

Shop.headerText ● String scalar

Header text.

Shop.fulfillmentAutoApprove ● Boolean! non-null scalar

Automatically approve all new fulfillments.

Added in Saleor 3.1

Shop.fulfillmentAllowUnpaid ● Boolean! non-null scalar

Allow to approve fulfillments which are unpaid.

Added in Saleor 3.1

Shop.trackInventoryByDefault ● Boolean scalar

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

Shop.defaultWeightUnit ● WeightUnitsEnum enum

Default weight unit.

Shop.translation ● ShopTranslation object

Returns translated shop fields for the given language code.

Shop.translation.languageCode ● LanguageCodeEnum! non-null enum

A language code to return the translation for shop.

Shop.automaticFulfillmentDigitalProducts ● Boolean scalar

Enable automatic fulfillment for all digital products.

Requires MANAGE_SETTINGSpermission.

Shop.reserveStockDurationAnonymousUser ● Int scalar

Default number of minutes stock will be reserved for anonymous checkout or null when stock reservation is disabled.

Added in Saleor 3.1

Requires MANAGE_SETTINGSpermission.

Shop.reserveStockDurationAuthenticatedUser ● Int scalar

Default number of minutes stock will be reserved for authenticated checkout or null when stock reservation is disabled.

Added in Saleor 3.1

Requires MANAGE_SETTINGSpermission.

Shop.limitQuantityPerCheckout ● Int scalar

Default number of maximum line quantity in single checkout (per single checkout line).

Added in Saleor 3.1

Requires MANAGE_SETTINGSpermission.

Shop.defaultDigitalMaxDownloads ● Int scalar

Default number of max downloads per digital content URL.

Requires MANAGE_SETTINGSpermission.

Shop.defaultDigitalUrlValidDays ● Int scalar

Default number of days which digital content URL will be valid.

Requires MANAGE_SETTINGSpermission.

Shop.companyAddress ● Address object

Company address.

Shop.customerSetPasswordUrl ● String scalar

URL of a view where customers can set their password.

Shop.staffNotificationRecipients ● [StaffNotificationRecipient!] list object

List of staff notification recipients.

Requires MANAGE_SETTINGSpermission.

Shop.enableAccountConfirmationByEmail ● Boolean scalar

Determines if account confirmation by email is enabled.

Added in Saleor 3.14

Requires MANAGE_SETTINGSpermission.

Shop.allowLoginWithoutConfirmation ● Boolean scalar

Determines if user can login without confirmation when enableAccountConfrimation is enabled.

Added in Saleor 3.15

Requires MANAGE_SETTINGSpermission.

Shop.limits ● LimitInfo! non-null object

Resource limitations and current usage if any set for a shop

Requires AUTHENTICATED_STAFF_USERpermission.

Shop.version ● String! non-null scalar

Saleor API version.

Requires one of the following permissions: AUTHENTICATED_STAFF_USERAUTHENTICATED_APP

Shop.schemaVersion ● String! non-null scalar

Minor Saleor API version.

Added in Saleor 3.5

Shop.includeTaxesInPrices ● Boolean! deprecated non-null scalar

DEPRECATED

This field will be removed in Saleor 4.0. Use Channel.taxConfiguration.pricesEnteredWithTax to determine whether prices are entered with tax.

Include taxes in prices.

Shop.displayGrossPrices ● Boolean! deprecated non-null scalar

DEPRECATED

This field will be removed in Saleor 4.0. Use Channel.taxConfiguration to determine whether to display gross or net prices.

Display prices with tax in store.

Shop.chargeTaxesOnShipping ● Boolean! deprecated non-null scalar

DEPRECATED

This field will be removed in Saleor 4.0. Use ShippingMethodType.taxClass to determine whether taxes are calculated for shipping methods; if a tax class is set, the taxes will be calculated, otherwise no tax rate will be applied.

Charge taxes on shipping.

Interfaces

ObjectWithMetadata interface

Returned by

shop query

Member of

AccountChangeEmailRequested object ● AccountConfirmationRequested object ● AccountConfirmed object ● AccountDeleted object ● AccountDeleteRequested object ● AccountEmailChanged object ● AccountSetPasswordRequested object ● ShopAddressUpdate object ● ShopDomainUpdate object ● ShopFetchTaxRates object ● ShopMetadataUpdated object ● ShopSettingsTranslate object ● ShopSettingsUpdate object ● StaffSetPasswordRequested object