Shop Object
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! @deprecated
version: String!
schemaVersion: String!
availableTaxApps: [App!]!
includeTaxesInPrices: Boolean! @deprecated
displayGrossPrices: Boolean! @deprecated
chargeTaxesOnShipping: Boolean! @deprecated
useLegacyUpdateWebhookEmission: Boolean @deprecated
}
Fields
privateMetadata ● [MetadataItem!]!
List of private metadata items. Requires staff permissions to access.
privateMetafield ● String
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
key ● String!
privateMetafields ● Metadata
Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.
keys ● [String!]
metadata ● [MetadataItem!]!
List of public metadata items. Can be accessed without permissions.
metafield ● String
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
key ● String!
metafields ● Metadata
Public metadata. Use keys to control which fields you want to include. The default is to include everything.
keys ● [String!]
id ● ID!
ID of the shop.
availablePaymentGateways ● [PaymentGateway!]!
List of available payment gateways.
currency ● String
Use channel argument instead.
A currency for which gateways will be returned.
channel ● String
Slug of a channel for which the data should be returned.
availableExternalAuthentications ● [ExternalAuthentication!]!
List of available external authentications.
availableShippingMethods ● [ShippingMethod!]
Shipping methods that are available for the shop.
channel ● String!
Slug of a channel for which the data should be returned.
address ● AddressInput
Address for which available shipping methods should be returned.
channelCurrencies ● [String!]!
List of all currencies supported by shop's channels.
countries ● [CountryDisplay!]!
List of countries available in the shop.
languageCode ● LanguageCodeEnum
No longer supported
A language code to return the translation for.
filter ● CountryFilterInput
Filtering options for countries
defaultCountry ● CountryDisplay
Shop's default country.
defaultMailSenderName ● String
Default shop's email sender's name.
defaultMailSenderAddress ● String
Default shop's email sender's address.
description ● String
Shop's description.
domain ● Domain!
Shop's domain data.
languages ● [LanguageDisplay!]!
List of the shops's supported languages.
name ● String!
Shop's name.
permissions ● [Permission!]!
List of available permissions.
phonePrefixes ● [String!]!
List of possible phone prefixes.
headerText ● String
Header text.
fulfillmentAutoApprove ● Boolean!
Automatically approve all new fulfillments.
fulfillmentAllowUnpaid ● Boolean!
Allow to approve fulfillments which are unpaid.
trackInventoryByDefault ● Boolean
This field is used as a default value for ProductVariant.trackInventory.
defaultWeightUnit ● WeightUnitsEnum
Default weight unit.
translation ● ShopTranslation
Returns translated shop fields for the given language code.
languageCode ● LanguageCodeEnum!
A language code to return the translation for shop.
automaticFulfillmentDigitalProducts ● Boolean
Enable automatic fulfillment for all digital products.
reserveStockDurationAnonymousUser ● Int
Default number of minutes stock will be reserved for anonymous checkout or null when stock reservation is disabled.
reserveStockDurationAuthenticatedUser ● Int
Default number of minutes stock will be reserved for authenticated checkout or null when stock reservation is disabled.
limitQuantityPerCheckout ● Int
Default number of maximum line quantity in single checkout (per single checkout line).
defaultDigitalMaxDownloads ● Int
Default number of max downloads per digital content URL.
defaultDigitalUrlValidDays ● Int
Default number of days which digital content URL will be valid.
companyAddress ● Address
Company address.
customerSetPasswordUrl ● String
URL of a view where customers can set their password.
staffNotificationRecipients ● [StaffNotificationRecipient!]
List of staff notification recipients.
enableAccountConfirmationByEmail ● Boolean
Determines if account confirmation by email is enabled.
allowLoginWithoutConfirmation ● Boolean
Determines if user can login without confirmation when enableAccountConfirmation is enabled.
version ● String!
Saleor API version.
schemaVersion ● String!
Minor Saleor API version.
availableTaxApps ● [App!]!
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.19Show deprecated
Interfaces
ObjectWithMetadata
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