Skip to main content
Version: 3.x

Shop

Represents a shop resource containing general shop data and configuration.

type Shop {
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
includeTaxesInPrices: Boolean!
fulfillmentAutoApprove: Boolean!
fulfillmentAllowUnpaid: Boolean!
displayGrossPrices: Boolean!
chargeTaxesOnShipping: 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!]
limits: LimitInfo!
version: String!
}

Fields

availablePaymentGateways ([PaymentGateway!]!)

List of available payment gateways.

A currency for which gateways will be returned.

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

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.

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

Address for which available shipping methods should be returned.

channelCurrencies ([String!]!)

List of all currencies supported by shop's channels.

Added in Saleor 3.1.

Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.

countries ([CountryDisplay!]!)

List of countries available in the shop.

A language code to return the translation for.

DEPRECATED: this field will be removed in Saleor 4.0.

Filtering options for countries

defaultCountry (CountryDisplay)

Shop's default country.

defaultMailSenderName (String)

Default shop's email sender's name.

Requires one of the following permissions: MANAGE_SETTINGS.

defaultMailSenderAddress (String)

Default shop's email sender's address.

Requires one of the following permissions: MANAGE_SETTINGS.

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.

includeTaxesInPrices (Boolean!)

Include taxes in prices.

fulfillmentAutoApprove (Boolean!)

Automatically approve all new fulfillments.

Added in Saleor 3.1.

fulfillmentAllowUnpaid (Boolean!)

Allow to approve fulfillments which are unpaid.

Added in Saleor 3.1.

displayGrossPrices (Boolean!)

Display prices with tax in store.

chargeTaxesOnShipping (Boolean!)

Charge taxes on shipping.

trackInventoryByDefault (Boolean)

Enable inventory tracking.

defaultWeightUnit (WeightUnitsEnum)

Default weight unit.

translation (ShopTranslation)

Returns translated shop fields for the given language code.

A language code to return the translation for shop.

automaticFulfillmentDigitalProducts (Boolean)

Enable automatic fulfillment for all digital products.

Requires one of the following permissions: MANAGE_SETTINGS.

reserveStockDurationAnonymousUser (Int)

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

Added in Saleor 3.1.

Requires one of the following permissions: MANAGE_SETTINGS.

reserveStockDurationAuthenticatedUser (Int)

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

Added in Saleor 3.1.

Requires one of the following permissions: MANAGE_SETTINGS.

limitQuantityPerCheckout (Int)

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

Added in Saleor 3.1.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

Requires one of the following permissions: MANAGE_SETTINGS.

defaultDigitalMaxDownloads (Int)

Default number of max downloads per digital content URL.

Requires one of the following permissions: MANAGE_SETTINGS.

defaultDigitalUrlValidDays (Int)

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

Requires one of the following permissions: MANAGE_SETTINGS.

companyAddress (Address)

Company address.

customerSetPasswordUrl (String)

URL of a view where customers can set their password.

staffNotificationRecipients ([StaffNotificationRecipient!])

List of staff notification recipients.

Requires one of the following permissions: MANAGE_SETTINGS.

limits (LimitInfo!)

Resource limitations and current usage if any set for a shop

Requires one of the following permissions: AUTHENTICATED_STAFF_USER.

version (String!)

Saleor API version.

Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.