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!
  availableTaxApps: [App!]!
  includeTaxesInPrices: Boolean! @deprecated
  displayGrossPrices: Boolean! @deprecated
  chargeTaxesOnShipping: Boolean! @deprecated
}

Expand ▼

Fields

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

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

Shop.privateMetafield ● String scalar miscellaneous

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 miscellaneous

Shop.privateMetafields ● Metadata scalar miscellaneous

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 miscellaneous

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

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

Shop.metafield ● String scalar miscellaneous

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

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

Shop.metafields ● Metadata scalar miscellaneous

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

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

Shop.id ● ID! non-null scalar miscellaneous

ID of the shop.

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

List of available payment gateways.

Shop.availablePaymentGateways.currency ● String scalar miscellaneous

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 miscellaneous

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

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

List of available external authentications.

Shop.availableShippingMethods ● [ShippingMethod!] list object shipping

Shipping methods that are available for the shop.

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

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

Shop.availableShippingMethods.address ● AddressInput input miscellaneous

Address for which available shipping methods should be returned.

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

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 miscellaneous

List of countries available in the shop.

Shop.countries.languageCode ● LanguageCodeEnum enum miscellaneous

A language code to return the translation for.

DEPRECATED: this field will be removed in Saleor 4.0.

Shop.countries.filter ● CountryFilterInput input miscellaneous

Filtering options for countries

Shop.defaultCountry ● CountryDisplay object miscellaneous

Shop's default country.

Shop.defaultMailSenderName ● String scalar miscellaneous

Default shop's email sender's name.

Requires MANAGE_SETTINGSpermission.

Shop.defaultMailSenderAddress ● String scalar miscellaneous

Default shop's email sender's address.

Requires MANAGE_SETTINGSpermission.

Shop.description ● String scalar miscellaneous

Shop's description.

Shop.domain ● Domain! non-null object miscellaneous

Shop's domain data.

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

List of the shops's supported languages.

Shop.name ● String! non-null scalar miscellaneous

Shop's name.

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

List of available permissions.

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

List of possible phone prefixes.

Shop.headerText ● String scalar miscellaneous

Header text.

Shop.fulfillmentAutoApprove ● Boolean! non-null scalar miscellaneous

Automatically approve all new fulfillments.

Added in Saleor 3.1

Shop.fulfillmentAllowUnpaid ● Boolean! non-null scalar miscellaneous

Allow to approve fulfillments which are unpaid.

Added in Saleor 3.1

Shop.trackInventoryByDefault ● Boolean scalar miscellaneous

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

Shop.defaultWeightUnit ● WeightUnitsEnum enum miscellaneous

Default weight unit.

Shop.translation ● ShopTranslation object shop

Returns translated shop fields for the given language code.

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

A language code to return the translation for shop.

Shop.automaticFulfillmentDigitalProducts ● Boolean scalar miscellaneous

Enable automatic fulfillment for all digital products.

Requires MANAGE_SETTINGSpermission.

Shop.reserveStockDurationAnonymousUser ● Int scalar miscellaneous

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 miscellaneous

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 miscellaneous

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 miscellaneous

Default number of max downloads per digital content URL.

Requires MANAGE_SETTINGSpermission.

Shop.defaultDigitalUrlValidDays ● Int scalar miscellaneous

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

Requires MANAGE_SETTINGSpermission.

Shop.companyAddress ● Address object users

Company address.

Shop.customerSetPasswordUrl ● String scalar miscellaneous

URL of a view where customers can set their password.

Shop.staffNotificationRecipients ● [StaffNotificationRecipient!] list object miscellaneous

List of staff notification recipients.

Requires MANAGE_SETTINGSpermission.

Shop.enableAccountConfirmationByEmail ● Boolean scalar miscellaneous

Determines if account confirmation by email is enabled.

Added in Saleor 3.14

Requires MANAGE_SETTINGSpermission.

Shop.allowLoginWithoutConfirmation ● Boolean scalar miscellaneous

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

Added in Saleor 3.15

Requires MANAGE_SETTINGSpermission.

Shop.limits ● LimitInfo! non-null object miscellaneous

Resource limitations and current usage if any set for a shop

Requires AUTHENTICATED_STAFF_USERpermission.

Shop.version ● String! non-null scalar miscellaneous

Saleor API version.

Requires one of the following permissions: AUTHENTICATED_STAFF_USERAUTHENTICATED_APP

Shop.schemaVersion ● String! non-null scalar miscellaneous

Minor Saleor API version.

Added in Saleor 3.5

Shop.availableTaxApps ● [App!]! non-null object apps

List of tax apps that can be assigned to the channel. The list will be calculated by Saleor based on the apps that are subscribed to webhooks related to tax calculations: CHECKOUT_CALCULATE_TAXES

Added in Saleor 3.19

Requires one of the following permissions: AUTHENTICATED_STAFF_USERMANAGE_APPS

Shop.includeTaxesInPrices ● Boolean! deprecated non-null scalar miscellaneous

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 miscellaneous

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 miscellaneous

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 miscellaneous

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