Home > @infiniteobjects/shopify-data-manager > AdminTypes > Shop
Represents a collection of general settings and information about the shop.
Signature:
export interface Shop extends HasMetafields, HasPublishedTranslations, Node
Extends: HasMetafields, HasPublishedTranslations, Node
| Property | Modifiers | Type | Description |
|---|---|---|---|
| alerts | Array<ShopAlert> | A list of the shop’s active alert messages that appear in the Shopify admin. | |
| allProductCategories | Array<ProductCategory> | A list of the shop’s product categories. Limit: 1000 product categories. | |
| analyticsToken | Scalars[‘String’][‘output’] | The token required to query the shop’s reports or dashboards. | |
| assignedFulfillmentOrders | FulfillmentOrderConnection | <p>The paginated list of fulfillment orders assigned to the shop locations owned by the app.</p><p>Assigned fulfillment orders are fulfillment orders that are set to be fulfilled from locations managed by [fulfillment services](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentService) that are registered by the app. One app (api_client) can host multiple fulfillment services on a shop. Each fulfillment service manages a dedicated location on a shop. Assigned fulfillment orders can have associated [fulfillment requests](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderRequestStatus), or might currently not be requested to be fulfilled.</p><p>The app must have read_assigned_fulfillment_orders [access scope](https://shopify.dev/docs/api/usage/access-scopes) to be able to retrieve fulfillment orders assigned to its locations.</p><p>All assigned fulfillment orders (except those with the CLOSED status) will be returned by default. Perform filtering with the assignmentStatus argument to receive only fulfillment orders that have been requested to be fulfilled.</p> |
|
| availableChannelApps | AppConnection | The list of sales channels not currently installed on the shop. | |
| billingAddress | ShopAddress | The shop’s billing address information. | |
| channelCount | Scalars[‘Int’][‘output’] | Exposes the number of channels. | |
| channelDefinitionsForInstalledChannels | Array<AvailableChannelDefinitionsByChannel> | List of all channel definitions associated with a shop. | |
| channels | ChannelConnection | List of the shop’s active sales channels. | |
| checkoutApiSupported | Scalars[‘Boolean’][‘output’] | Specifies whether the shop supports checkouts via Checkout API. | |
| collectionByHandle? | Maybe<Collection> | (Optional) Return a collection by its handle. | |
| collections | CollectionConnection | List of the shop’s collections. | |
| collectionSavedSearches | SavedSearchConnection | List of the shop’s collection saved searches. | |
| contactEmail | Scalars[‘String’][‘output’] | The public-facing contact email address for the shop. Customers will use this email to communicate with the shop owner. | |
| countriesInShippingZones | CountriesInShippingZones | Countries that have been defined in shipping zones for the shop. | |
| currencyCode | CurrencyCode | `${CurrencyCode}` | The three letter code for the currency that the shop sells in. | |
| currencyFormats | CurrencyFormats | How currencies are displayed on your store. | |
| currencySettings | CurrencySettingConnection | The presentment currency settings for the shop excluding the shop’s own currency. | |
| customerAccounts | ShopCustomerAccountsSetting | `${ShopCustomerAccountsSetting}` | Whether customer accounts are required, optional, or disabled for the shop. | |
| customerAccountsV2 | CustomerAccountsV2 | Information about the shop’s customer accounts. | |
| customers | CustomerConnection | Customer accounts associated to the shop. | |
| customerSavedSearches | SavedSearchConnection | List of the shop’s customer saved searches. | |
| customerTags | StringConnection | A list of tags that have been added to customer accounts. | |
| description? | Maybe<Scalars[‘String’][‘output’]> | (Optional) The shop’s meta description used in search engine results. | |
| domains | Array<Domain> | The domains configured for the shop. | |
| draftOrders | DraftOrderConnection | List of saved draft orders on the shop. | |
| draftOrderSavedSearches | SavedSearchConnection | List of the shop’s draft order saved searches. | |
| draftOrderTags | StringConnection | A list of tags that have been added to draft orders. | |
| Scalars[‘String’][‘output’] | The shop owner’s email address. Shopify will use this email address to communicate with the shop owner. | ||
| enabledPresentmentCurrencies | Array<CurrencyCode | `${CurrencyCode}`> | The presentment currencies enabled for the shop. | |
| features | ShopFeatures | The set of features enabled for the shop. | |
| fulfillmentOrders | FulfillmentOrderConnection | The paginated list of merchant-managed and third-party fulfillment orders. | |
| fulfillmentServices | Array<FulfillmentService> | List of the shop’s installed fulfillment services. | |
| ianaTimezone | Scalars[‘String’][‘output’] | The shop’s time zone as defined by the IANA. | |
| id | Scalars[‘ID’][‘output’] | A globally-unique ID. | |
| inventoryItems | InventoryItemConnection | List of the shop’s inventory items. | |
| limitedPendingOrderCount | LimitedPendingOrderCount | The number of pendings orders on the shop. Limited to a maximum of 10000. | |
| locations | LocationConnection | List of active locations of the shop. | |
| marketingEvents | MarketingEventConnection | List of a shop’s marketing events. | |
| merchantApprovalSignals? | Maybe<MerchantApprovalSignals> | (Optional) The approval signals for a shop to support onboarding to channel apps. | |
| metafield? | Maybe<Metafield> | (Optional) Returns a metafield by namespace and key that belongs to the resource. | |
| metafields | MetafieldConnection | List of metafields that belong to the resource. | |
| myshopifyDomain | Scalars[‘String’][‘output’] | The shop’s .myshopify.com domain name. | |
| name | Scalars[‘String’][‘output’] | The shop’s name. | |
| navigationSettings | Array<NavigationItem> | The shop’s settings related to navigation. | |
| orderNumberFormatPrefix | Scalars[‘String’][‘output’] | The prefix that appears before order numbers. | |
| orderNumberFormatSuffix | Scalars[‘String’][‘output’] | The suffix that appears after order numbers. | |
| orders | OrderConnection | A list of the shop’s orders. | |
| orderSavedSearches | SavedSearchConnection | List of the shop’s order saved searches. | |
| orderTags | StringConnection | A list of tags that have been added to orders. | |
| paymentSettings | PaymentSettings | The shop’s settings related to payments. | |
| pendingOrderCount | Scalars[‘Int’][‘output’] | Number of pending orders on the shop. | |
| plan | ShopPlan | The shop’s billing plan. | |
| priceRules | PriceRuleConnection | List of the shop’s price rules. | |
| priceRuleSavedSearches | SavedSearchConnection | List of the shop’s price rule saved searches. | |
| primaryDomain | Domain | The primary domain of the shop’s online store. | |
| privateMetafield? | Maybe<PrivateMetafield> | (Optional) Returns a private metafield by namespace and key that belongs to the resource. | |
| privateMetafields | PrivateMetafieldConnection | List of private metafields that belong to the resource. | |
| productByHandle? | Maybe<Product> | (Optional) Return a product by its handle. | |
| productImages | ImageConnection | The list of all images of all products for the shop. | |
| products | ProductConnection | List of the shop’s products. | |
| productSavedSearches | SavedSearchConnection | List of the shop’s product saved searches. | |
| productTags | StringConnection | A list of tags that have been added to products. | |
| productTypes | StringConnection | The list of types added to products. | |
| productVariants | ProductVariantConnection | List of the shop’s product variants. | |
| productVendors | StringConnection | The list of vendors added to products. | |
| publicationCount | Scalars[‘Int’][‘output’] | The number of publications for the shop. | |
| resourceLimits | ShopResourceLimits | The shop’s limits for specific resources. For example, the maximum number ofvariants allowed per product, or the maximum number of locations allowed. | |
| richTextEditorUrl | Scalars[‘URL’][‘output’] | The URL of the rich text editor that can be used for mobile devices. | |
| search | SearchResultConnection | Fetches a list of admin search results by a specified query. | |
| searchFilters | SearchFilterOptions | The list of search filter options for the shop. These can be used to filter productvisibility for the shop. | |
| setupRequired | Scalars[‘Boolean’][‘output’] | Whether the shop has outstanding setup steps. | |
| shipsToCountries | Array<CountryCode | `${CountryCode}`> | The list of countries that the shop ships to. | |
| shopPolicies | Array<ShopPolicy> | The list of all legal policies associated with a shop. | |
| staffMembers | StaffMemberConnection | The paginated list of the shop’s staff members. | |
| storefrontAccessTokens | StorefrontAccessTokenConnection | The storefront access token of a private application. These are scoped per-application. | |
| storefrontUrl | Scalars[‘URL’][‘output’] | The URL of the shop’s storefront. | |
| taxesIncluded | Scalars[‘Boolean’][‘output’] | Whether applicable taxes are included in the shop’s product prices. | |
| taxShipping | Scalars[‘Boolean’][‘output’] | Whether the shop charges taxes for shipping. | |
| timezoneAbbreviation | Scalars[‘String’][‘output’] | The shop’s time zone abbreviation. | |
| timezoneOffset | Scalars[‘String’][‘output’] | The shop’s time zone offset. | |
| timezoneOffsetMinutes | Scalars[‘Int’][‘output’] | The shop’s time zone offset expressed as a number of minutes. | |
| transactionalSmsDisabled | Scalars[‘Boolean’][‘output’] | Whether transactional SMS sent by Shopify have been disabled for a shop. | |
| translations | Array<Translation> | The translations associated with the resource. | |
| unitSystem | UnitSystem | `${UnitSystem}` | The shop’s unit system for weights and measures. | |
| uploadedImagesByIds | Array<Image> | Fetches a list of images uploaded to the shop by their IDs. | |
| url | Scalars[‘URL’][‘output’] | The URL of the shop’s online store. | |
| weightUnit | WeightUnit | `${WeightUnit}` | The shop’s primary unit of weight for products and shipping. |