shop - admin-graphql - QUERY

Version: 2024-07

Description:

Returns the Shop resource corresponding to the access token used in the request. The Shop resource contains business and store management settings for the shop.

Access Scopes

Arguments

Returns

• alerts: ShopAlert! A list of the shop's active alert messages that appear in the Shopify admin.
• allProductCategories: ProductCategory! A list of the shop's product categories. Limit: 1000 product categories.
• allProductCategoriesList: TaxonomyCategory! A list of the shop's product categories. Limit: 1000 product categories.
• analyticsToken: String! The token required to query the shop's reports or dashboards.
• billingAddress: ShopAddress! The shop's billing address information.
• channelDefinitionsForInstalledChannels: AvailableChannelDefinitionsByChannel! List of all channel definitions associated with a shop.
• checkoutApiSupported: Boolean! Specifies whether the shop supports checkouts via Checkout API.
• collectionByHandle: Collection Return a collection by its handle.
• contactEmail: String! 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.
• createdAt: DateTime! The date and time when the shop was created.
• currencyCode: CurrencyCode! The three letter code for the currency that the shop sells in.
• currencyFormats: CurrencyFormats! How currencies are displayed on your store.
• customerAccounts: ShopCustomerAccountsSetting! Whether customer accounts are required, optional, or disabled for the shop.
• customerAccountsV2: CustomerAccountsV2! Information about the shop's customer accounts.
• description: String The shop's meta description used in search engine results.
• domains: Domain! The domains configured for the shop.
• email: String! The shop owner's email address. Shopify will use this email address to communicate with the shop owner.
• enabledPresentmentCurrencies: CurrencyCode! The presentment currencies enabled for the shop.
• features: ShopFeatures! The set of features enabled for the shop.
• fulfillmentServices: FulfillmentService! List of the shop's installed fulfillment services.
• ianaTimezone: String! The shop's time zone as defined by the IANA.
• id: ID! A globally-unique ID.
• limitedPendingOrderCount: LimitedPendingOrderCount! The number of pendings orders on the shop. Limited to a maximum of 10000.
• marketingSmsConsentEnabledAtCheckout: Boolean! Whether SMS marketing has been enabled on the shop's checkout configuration settings.
• merchantApprovalSignals: MerchantApprovalSignals The approval signals for a shop to support onboarding to channel apps.
• metafield: Metafield A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information.
• myshopifyDomain: String! The shop's .myshopify.com domain name.
• name: String! The shop's name.
• navigationSettings: NavigationItem! The shop's settings related to navigation.
• orderNumberFormatPrefix: String! The prefix that appears before order numbers.
• orderNumberFormatSuffix: String! The suffix that appears after order numbers.
• paymentSettings: PaymentSettings! The shop's settings related to payments.
• plan: ShopPlan! The shop's billing plan.
• primaryDomain: Domain! The primary domain of the shop's online store.
• privateMetafield: PrivateMetafield Returns a private metafield by namespace and key that belongs to the resource.
• productByHandle: Product Return a product by its handle.
• publicationCount: Int! 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: URL! The URL of the rich text editor that can be used for mobile devices.
• searchFilters: SearchFilterOptions! The list of search filter options for the shop. These can be used to filter productvisibility for the shop.
• setupRequired: Boolean! Whether the shop has outstanding setup steps.
• shipsToCountries: CountryCode! The list of countries that the shop ships to.
• shopPolicies: ShopPolicy! The list of all legal policies associated with a shop.
• storefrontUrl: URL! The URL of the shop's storefront.
• taxShipping: Boolean! Whether the shop charges taxes for shipping.
• taxesIncluded: Boolean! Whether applicable taxes are included in the shop's product prices.
• timezoneAbbreviation: String! The shop's time zone abbreviation.
• timezoneOffset: String! The shop's time zone offset.
• timezoneOffsetMinutes: Int! The shop's time zone offset expressed as a number of minutes.
• transactionalSmsDisabled: Boolean! Whether transactional SMS sent by Shopify have been disabled for a shop.
• translations: Translation! The published translations associated with the resource.
• unitSystem: UnitSystem! The shop's unit system for weights and measures.
• updatedAt: DateTime! The date and time when the shop was last updated.
• uploadedImagesByIds: Image! Fetches a list of images uploaded to the shop by their IDs.
• url: URL! The URL of the shop's online store.
• weightUnit: WeightUnit! The shop's primary unit of weight for products and shipping.

Examples

• Get a metafield attached to a shop

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query ShopMetafield($namespace: String!, $key: String!) { shop { copyrightYear: metafield(namespace: $namespace, key: $key) { value } } }\",\n \"variables\": {\n    \"namespace\": \"my_fields\",\n    \"key\": \"copyright_year\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query ShopMetafield($namespace: String!, $key: String!) {\n      shop {\n        copyrightYear: metafield(namespace: $namespace, key: $key) {\n          value\n        }\n      }\n    }`,\n    \"variables\": {\n      \"namespace\": \"my_fields\",\n      \"key\": \"copyright_year\"\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query ShopMetafield($namespace: String!, $key: String!) {\n    shop {\n      copyrightYear: metafield(namespace: $namespace, key: $key) {\n        value\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"namespace\": \"my_fields\",\n  \"key\": \"copyright_year\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query ShopMetafield($namespace: String!, $key: String!) {\n    shop {\n      copyrightYear: metafield(namespace: $namespace, key: $key) {\n        value\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"namespace\" => \"my_fields\",\n  \"key\" => \"copyright_year\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query ShopMetafield($namespace: String!, $key: String!) {\n    shop {\n      copyrightYear: metafield(namespace: $namespace, key: $key) {\n        value\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"namespace\": \"my_fields\",\n      \"key\": \"copyright_year\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query ShopMetafield($namespace: String!, $key: String!) {\n  shop {\n    copyrightYear: metafield(namespace: $namespace, key: $key) {\n      value\n    }\n  }\n}"
        

  input: {
    "namespace": "my_fields",
    "key": "copyright_year"
  }

  response: {
    "data": {
      "shop": {
        "copyrightYear": {
          "value": "2022"
        }
      }
    }
  }

  Get metafields attached to a shop

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query ShopMetafields { shop { metafields(first: 3) { edges { node { namespace key value } } } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query ShopMetafields {\n    shop {\n      metafields(first: 3) {\n        edges {\n          node {\n            namespace\n            key\n            value\n          }\n        }\n      }\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query ShopMetafields {\n    shop {\n      metafields(first: 3) {\n        edges {\n          node {\n            namespace\n            key\n            value\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query ShopMetafields {\n    shop {\n      metafields(first: 3) {\n        edges {\n          node {\n            namespace\n            key\n            value\n          }\n        }\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query ShopMetafields {\n    shop {\n      metafields(first: 3) {\n        edges {\n          node {\n            namespace\n            key\n            value\n          }\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query ShopMetafields {\n  shop {\n    metafields(first: 3) {\n      edges {\n        node {\n          namespace\n          key\n          value\n        }\n      }\n    }\n  }\n}"
        

  input: {}

  response: {
    "data": {
      "shop": {
        "metafields": {
          "edges": [
            {
              "node": {
                "namespace": "my_fields",
                "key": "copyright_year",
                "value": "2022"
              }
            }
          ]
        }
      }
    }
  }

  Receive a list of all FulfillmentServices

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query FulfillmentServiceList { shop { fulfillmentServices { id callbackUrl fulfillmentOrdersOptIn permitsSkuSharing handle inventoryManagement serviceName } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query FulfillmentServiceList {\n    shop {\n      fulfillmentServices {\n        id\n        callbackUrl\n        fulfillmentOrdersOptIn\n        permitsSkuSharing\n        handle\n        inventoryManagement\n        serviceName\n      }\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query FulfillmentServiceList {\n    shop {\n      fulfillmentServices {\n        id\n        callbackUrl\n        fulfillmentOrdersOptIn\n        permitsSkuSharing\n        handle\n        inventoryManagement\n        serviceName\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query FulfillmentServiceList {\n    shop {\n      fulfillmentServices {\n        id\n        callbackUrl\n        fulfillmentOrdersOptIn\n        permitsSkuSharing\n        handle\n        inventoryManagement\n        serviceName\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query FulfillmentServiceList {\n    shop {\n      fulfillmentServices {\n        id\n        callbackUrl\n        fulfillmentOrdersOptIn\n        permitsSkuSharing\n        handle\n        inventoryManagement\n        serviceName\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query FulfillmentServiceList {\n  shop {\n    fulfillmentServices {\n      id\n      callbackUrl\n      fulfillmentOrdersOptIn\n      permitsSkuSharing\n      handle\n      inventoryManagement\n      serviceName\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "shop": {
        "fulfillmentServices": [
          {
            "id": "gid://shopify/FulfillmentService/manual",
            "callbackUrl": null,
            "fulfillmentOrdersOptIn": false,
            "permitsSkuSharing": true,
            "handle": "manual",
            "inventoryManagement": false,
            "serviceName": "Manual"
          },
          {
            "id": "gid://shopify/FulfillmentService/18961920?id=true",
            "callbackUrl": "http://shipwire.com",
            "fulfillmentOrdersOptIn": true,
            "permitsSkuSharing": true,
            "handle": "shipwire",
            "inventoryManagement": false,
            "serviceName": "Shipwire"
          },
          {
            "id": "gid://shopify/FulfillmentService/198258461?id=true",
            "callbackUrl": "http://google.com",
            "fulfillmentOrdersOptIn": true,
            "permitsSkuSharing": false,
            "handle": "on-demand-delivery",
            "inventoryManagement": false,
            "serviceName": "On Demand Delivery"
          },
          {
            "id": "gid://shopify/FulfillmentService/736057333?id=true",
            "callbackUrl": null,
            "fulfillmentOrdersOptIn": false,
            "permitsSkuSharing": false,
            "handle": "mr-acme-drop-shipper",
            "inventoryManagement": false,
            "serviceName": "Mr. ACME Drop Shipper"
          },
          {
            "id": "gid://shopify/FulfillmentService/1061774486?id=true",
            "callbackUrl": null,
            "fulfillmentOrdersOptIn": false,
            "permitsSkuSharing": false,
            "handle": "mr-drop-shipper",
            "inventoryManagement": false,
            "serviceName": "Mr. Drop Shipper"
          }
        ]
      }
    }
  }

  Retrieve information about a shop

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { shop { name currencyCode checkoutApiSupported taxesIncluded resourceLimits { maxProductVariants } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    shop {\n      name\n      currencyCode\n      checkoutApiSupported\n      taxesIncluded\n      resourceLimits {\n        maxProductVariants\n      }\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query {\n    shop {\n      name\n      currencyCode\n      checkoutApiSupported\n      taxesIncluded\n      resourceLimits {\n        maxProductVariants\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query {\n    shop {\n      name\n      currencyCode\n      checkoutApiSupported\n      taxesIncluded\n      resourceLimits {\n        maxProductVariants\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    shop {\n      name\n      currencyCode\n      checkoutApiSupported\n      taxesIncluded\n      resourceLimits {\n        maxProductVariants\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  shop {\n    name\n    currencyCode\n    checkoutApiSupported\n    taxesIncluded\n    resourceLimits {\n      maxProductVariants\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "shop": {
        "name": "Snowdevil",
        "currencyCode": "USD",
        "checkoutApiSupported": true,
        "taxesIncluded": false,
        "resourceLimits": {
          "maxProductVariants": 100
        }
      }
    }
  }

  Retrieves a list of fulfillment orders assigned to the shop locations that are owned by the app

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query AssignedFulfillmentOrderList($assignmentStatus: FulfillmentOrderAssignmentStatus) { shop { assignedFulfillmentOrders(first: 10, assignmentStatus: $assignmentStatus) { edges { node { id status requestStatus destination { firstName lastName address1 city province zip countryCode phone } lineItems(first: 10) { edges { node { id productTitle sku remainingQuantity } } } } } } } }\",\n \"variables\": {\n    \"assignmentStatus\": \"FULFILLMENT_REQUESTED\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query AssignedFulfillmentOrderList($assignmentStatus: FulfillmentOrderAssignmentStatus) {\n      shop {\n        assignedFulfillmentOrders(first: 10, assignmentStatus: $assignmentStatus) {\n          edges {\n            node {\n              id\n              status\n              requestStatus\n              destination {\n                firstName\n                lastName\n                address1\n                city\n                province\n                zip\n                countryCode\n                phone\n              }\n              lineItems(first: 10) {\n                edges {\n                  node {\n                    id\n                    productTitle\n                    sku\n                    remainingQuantity\n                  }\n                }\n              }\n            }\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"assignmentStatus\": \"FULFILLMENT_REQUESTED\"\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query AssignedFulfillmentOrderList($assignmentStatus: FulfillmentOrderAssignmentStatus) {\n    shop {\n      assignedFulfillmentOrders(first: 10, assignmentStatus: $assignmentStatus) {\n        edges {\n          node {\n            id\n            status\n            requestStatus\n            destination {\n              firstName\n              lastName\n              address1\n              city\n              province\n              zip\n              countryCode\n              phone\n            }\n            lineItems(first: 10) {\n              edges {\n                node {\n                  id\n                  productTitle\n                  sku\n                  remainingQuantity\n                }\n              }\n            }\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"assignmentStatus\": \"FULFILLMENT_REQUESTED\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query AssignedFulfillmentOrderList($assignmentStatus: FulfillmentOrderAssignmentStatus) {\n    shop {\n      assignedFulfillmentOrders(first: 10, assignmentStatus: $assignmentStatus) {\n        edges {\n          node {\n            id\n            status\n            requestStatus\n            destination {\n              firstName\n              lastName\n              address1\n              city\n              province\n              zip\n              countryCode\n              phone\n            }\n            lineItems(first: 10) {\n              edges {\n                node {\n                  id\n                  productTitle\n                  sku\n                  remainingQuantity\n                }\n              }\n            }\n          }\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"assignmentStatus\" => \"FULFILLMENT_REQUESTED\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query AssignedFulfillmentOrderList($assignmentStatus: FulfillmentOrderAssignmentStatus) {\n    shop {\n      assignedFulfillmentOrders(first: 10, assignmentStatus: $assignmentStatus) {\n        edges {\n          node {\n            id\n            status\n            requestStatus\n            destination {\n              firstName\n              lastName\n              address1\n              city\n              province\n              zip\n              countryCode\n              phone\n            }\n            lineItems(first: 10) {\n              edges {\n                node {\n                  id\n                  productTitle\n                  sku\n                  remainingQuantity\n                }\n              }\n            }\n          }\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"assignmentStatus\": \"FULFILLMENT_REQUESTED\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query AssignedFulfillmentOrderList($assignmentStatus: FulfillmentOrderAssignmentStatus) {\n  shop {\n    assignedFulfillmentOrders(first: 10, assignmentStatus: $assignmentStatus) {\n      edges {\n        node {\n          id\n          status\n          requestStatus\n          destination {\n            firstName\n            lastName\n            address1\n            city\n            province\n            zip\n            countryCode\n            phone\n          }\n          lineItems(first: 10) {\n            edges {\n              node {\n                id\n                productTitle\n                sku\n                remainingQuantity\n              }\n            }\n          }\n        }\n      }\n    }\n  }\n}"
        

  input: {
    "assignmentStatus": "FULFILLMENT_REQUESTED"
  }

  response: {
    "data": {
      "shop": {
        "assignedFulfillmentOrders": {
          "edges": [
            {
              "node": {
                "id": "gid://shopify/FulfillmentOrder/1046001474",
                "status": "OPEN",
                "requestStatus": "SUBMITTED",
                "destination": null,
                "lineItems": {
                  "edges": []
                }
              }
            }
          ]
        }
      }
    }
  }

  Retrieves a list of all users

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { shop { staffMembers(first: 10) { edges { node { active avatar { url } email exists firstName id initials isShopOwner lastName locale name phone } } } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    shop {\n      staffMembers(first: 10) {\n        edges {\n          node {\n            active\n            avatar {\n              url\n            }\n            email\n            exists\n            firstName\n            id\n            initials\n            isShopOwner\n            lastName\n            locale\n            name\n            phone\n          }\n        }\n      }\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query {\n    shop {\n      staffMembers(first: 10) {\n        edges {\n          node {\n            active\n            avatar {\n              url\n            }\n            email\n            exists\n            firstName\n            id\n            initials\n            isShopOwner\n            lastName\n            locale\n            name\n            phone\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query {\n    shop {\n      staffMembers(first: 10) {\n        edges {\n          node {\n            active\n            avatar {\n              url\n            }\n            email\n            exists\n            firstName\n            id\n            initials\n            isShopOwner\n            lastName\n            locale\n            name\n            phone\n          }\n        }\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    shop {\n      staffMembers(first: 10) {\n        edges {\n          node {\n            active\n            avatar {\n              url\n            }\n            email\n            exists\n            firstName\n            id\n            initials\n            isShopOwner\n            lastName\n            locale\n            name\n            phone\n          }\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  shop {\n    staffMembers(first: 10) {\n      edges {\n        node {\n          active\n          avatar {\n            url\n          }\n          email\n          exists\n          firstName\n          id\n          initials\n          isShopOwner\n          lastName\n          locale\n          name\n          phone\n        }\n      }\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "shop": {
        "staffMembers": {
          "edges": [
            {
              "node": {
                "active": true,
                "avatar": {
                  "url": "https://cdn.shopify.com/proxy/106ea358a244c6081c66489854c884cbfa858aec3c1730397e34bd4f4992f21e/www.gravatar.com/avatar/a902d35d9cd3096a7285782c69dd4622.jpg?s=2048&d=https%3A%2F%2Fcdn.shopify.com%2Fshopifycloud%2Fshopify%2Fassets%2Fno-gravatar-new-04e7c2331218ac202e79e31be502fd5631bc96cb0206580dbcb0720ebbbd7c73.png"
                },
                "email": "sales@example.com",
                "exists": true,
                "firstName": "angie",
                "id": "gid://shopify/StaffMember/1039577421",
                "initials": [
                  "a",
                  "l"
                ],
                "isShopOwner": false,
                "lastName": "lucuos",
                "locale": "en",
                "name": "angie lucuos",
                "phone": null
              }
            },
            {
              "node": {
                "active": true,
                "avatar": {
                  "url": "https://cdn.shopify.com/proxy/29f98977e6ce2b24120b4d26ce7fde694b7bafc46a6be575ce88cf26a789c4e6/www.gravatar.com/avatar/4df4299bb7b53d4a9e8989238f81c15d.jpg?s=2048&d=https%3A%2F%2Fcdn.shopify.com%2Fshopifycloud%2Fshopify%2Fassets%2Fno-gravatar-new-04e7c2331218ac202e79e31be502fd5631bc96cb0206580dbcb0720ebbbd7c73.png"
                },
                "email": "arnie@champion.example.com",
                "exists": true,
                "firstName": "Arnold",
                "id": "gid://shopify/StaffMember/863601736",
                "initials": [
                  "S",
                  "n"
                ],
                "isShopOwner": false,
                "lastName": "Schwarzenegger",
                "locale": "en",
                "name": "Snow Devil Inc.",
                "phone": null
              }
            },
            {
              "node": {
                "active": true,
                "avatar": {
                  "url": "https://cdn.shopify.com/s/files/1/2637/1970/users/foo.jpg?v=1731443626"
                },
                "email": "bob@example.com",
                "exists": true,
                "firstName": "bob",
                "id": "gid://shopify/StaffMember/902541635",
                "initials": [
                  "b",
                  "b"
                ],
                "isShopOwner": true,
                "lastName": "bobsen",
                "locale": "en",
                "name": "bob bobsen",
                "phone": null
              }
            },
            {
              "node": {
                "active": true,
                "avatar": {
                  "url": "https://cdn.shopify.com/proxy/a2fa3a40bc8b418a7e6a69413fb84a57164b6f4ce6757d4163ffda4302e02682/www.gravatar.com/avatar/59aa4f8e9b82c046003452b23e3b881e.jpg?s=2048&d=https%3A%2F%2Fcdn.shopify.com%2Fshopifycloud%2Fshopify%2Fassets%2Fno-gravatar-new-04e7c2331218ac202e79e31be502fd5631bc96cb0206580dbcb0720ebbbd7c73.png"
                },
                "email": "pos@shopify.com",
                "exists": true,
                "firstName": "bob",
                "id": "gid://shopify/StaffMember/1004723144",
                "initials": [
                  "b",
                  "b"
                ],
                "isShopOwner": false,
                "lastName": "bobsen",
                "locale": "en",
                "name": "bob bobsen",
                "phone": null
              }
            },
            {
              "node": {
                "active": true,
                "avatar": {
                  "url": "https://cdn.shopify.com/proxy/739472b8350cf18a7f2058ef2d37019d4026bcb276844fa3d192eed26b594e27/www.gravatar.com/avatar/6fe88e20596eb227b53b543c2cece91e.jpg?s=2048&d=https%3A%2F%2Fcdn.shopify.com%2Fshopifycloud%2Fshopify%2Fassets%2Fno-gravatar-new-04e7c2331218ac202e79e31be502fd5631bc96cb0206580dbcb0720ebbbd7c73.png"
                },
                "email": "collaborator_bob@example.com",
                "exists": true,
                "firstName": "collaborator",
                "id": "gid://shopify/StaffMember/688782760",
                "initials": [
                  "S",
                  "n"
                ],
                "isShopOwner": false,
                "lastName": "bob",
                "locale": "en",
                "name": "Snow Devil Inc.",
                "phone": null
              }
            },
            {
              "node": {
                "active": true,
                "avatar": {
                  "url": "https://cdn.shopify.com/proxy/8149b06b8974a1092082b18147941ef437a669fa6db5aba0ccd80bee9b33b788/www.gravatar.com/avatar/866ad7602839b586d7d18cb11b131881.jpg?s=2048&d=https%3A%2F%2Fcdn.shopify.com%2Fshopifycloud%2Fshopify%2Fassets%2Fno-gravatar-new-04e7c2331218ac202e79e31be502fd5631bc96cb0206580dbcb0720ebbbd7c73.png"
                },
                "email": "customereventsbob@example.com",
                "exists": true,
                "firstName": "customereventsbob",
                "id": "gid://shopify/StaffMember/216359514",
                "initials": [
                  "c",
                  "b"
                ],
                "isShopOwner": false,
                "lastName": "bobsen",
                "locale": "en",
                "name": "customereventsbob bobsen",
                "phone": null
              }
            },
            {
              "node": {
                "active": true,
                "avatar": {
                  "url": "https://cdn.shopify.com/proxy/9a11b2a61faef02c90cae564d6cd8f61c9c5932abdc470375ea4af38d2234678/www.gravatar.com/avatar/a30775a5f88642adceaa3a6ff418ff4d.jpg?s=2048&d=https%3A%2F%2Fcdn.shopify.com%2Fshopifycloud%2Fshopify%2Fassets%2Fno-gravatar-new-04e7c2331218ac202e79e31be502fd5631bc96cb0206580dbcb0720ebbbd7c73.png"
                },
                "email": "customereventsbobnoapps@example.com",
                "exists": true,
                "firstName": "customereventsbobnoapps",
                "id": "gid://shopify/StaffMember/257608065",
                "initials": [
                  "c",
                  "b"
                ],
                "isShopOwner": false,
                "lastName": "bobsen",
                "locale": "en",
                "name": "customereventsbobnoapps bobsen",
                "phone": null
              }
            },
            {
              "node": {
                "active": true,
                "avatar": {
                  "url": "https://cdn.shopify.com/proxy/d0f4af069a9948a91f75815dcf3c24b7bd775bb8fa66571da1b257f2fd2eacf5/www.gravatar.com/avatar/3111a27ed0d92a4209a15190114490d4.jpg?s=2048&d=https%3A%2F%2Fcdn.shopify.com%2Fshopifycloud%2Fshopify%2Fassets%2Fno-gravatar-new-04e7c2331218ac202e79e31be502fd5631bc96cb0206580dbcb0720ebbbd7c73.png"
                },
                "email": "customereventsbobwithoneapp@example.com",
                "exists": true,
                "firstName": "customereventsbobwithoneapp",
                "id": "gid://shopify/StaffMember/584611871",
                "initials": [
                  "c",
                  "b"
                ],
                "isShopOwner": false,
                "lastName": "bobsen",
                "locale": "en",
                "name": "customereventsbobwithoneapp bobsen",
                "phone": null
              }
            },
            {
              "node": {
                "active": false,
                "avatar": {
                  "url": "https://cdn.shopify.com/proxy/0feaeef95fe37c482d1472c776d9f5c35f3f4b0a051fef68bf702422c284f5fd/www.gravatar.com/avatar/cc9f2fc36ad3c135e4984fc6f63c4c16.jpg?s=2048&d=https%3A%2F%2Fcdn.shopify.com%2Fshopifycloud%2Fshopify%2Fassets%2Fno-gravatar-new-04e7c2331218ac202e79e31be502fd5631bc96cb0206580dbcb0720ebbbd7c73.png"
                },
                "email": "deactivateduser@example.com",
                "exists": true,
                "firstName": "deactivated",
                "id": "gid://shopify/StaffMember/667736507",
                "initials": [
                  "d",
                  "u"
                ],
                "isShopOwner": false,
                "lastName": "user",
                "locale": "en",
                "name": "deactivated user",
                "phone": null
              }
            },
            {
              "node": {
                "active": true,
                "avatar": {
                  "url": "https://cdn.shopify.com/proxy/bb267d2b2b59370b919f9c8f42719ece9e33c84ee51230220405746dd8c5c504/www.gravatar.com/avatar/68bd9ae0240cb5cfd89463b1fe778375.jpg?s=2048&d=https%3A%2F%2Fcdn.shopify.com%2Fshopifycloud%2Fshopify%2Fassets%2Fno-gravatar-new-04e7c2331218ac202e79e31be502fd5631bc96cb0206580dbcb0720ebbbd7c73.png"
                },
                "email": "existingbob@example.com",
                "exists": true,
                "firstName": "existingbob",
                "id": "gid://shopify/StaffMember/2108187",
                "initials": [
                  "e",
                  "b"
                ],
                "isShopOwner": false,
                "lastName": "bobsen",
                "locale": "en",
                "name": "existingbob bobsen",
                "phone": "3213213211"
              }
            }
          ]
        }
      }
    }
  }

  Retrieves a list of currencies enabled on a shop

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { shop { currencySettings(first: 1) { edges { node { currencyCode rateUpdatedAt } } } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    shop {\n      currencySettings(first: 1) {\n        edges {\n          node {\n            currencyCode\n            rateUpdatedAt\n          }\n        }\n      }\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query {\n    shop {\n      currencySettings(first: 1) {\n        edges {\n          node {\n            currencyCode\n            rateUpdatedAt\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query {\n    shop {\n      currencySettings(first: 1) {\n        edges {\n          node {\n            currencyCode\n            rateUpdatedAt\n          }\n        }\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    shop {\n      currencySettings(first: 1) {\n        edges {\n          node {\n            currencyCode\n            rateUpdatedAt\n          }\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  shop {\n    currencySettings(first: 1) {\n      edges {\n        node {\n          currencyCode\n          rateUpdatedAt\n        }\n      }\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "shop": {
        "currencySettings": {
          "edges": [
            {
              "node": {
                "currencyCode": "CAD",
                "rateUpdatedAt": "2018-01-24T00:01:01Z"
              }
            }
          ]
        }
      }
    }
  }

  Retrieves a list of storefront access tokens that have been issued

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query storefrontAccessToken { shop { storefrontAccessTokens(first: 10) { edges { node { id accessToken accessScopes { handle } createdAt title } } } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query storefrontAccessToken {\n    shop {\n      storefrontAccessTokens(first: 10) {\n        edges {\n          node {\n            id\n            accessToken\n            accessScopes {\n              handle\n            }\n            createdAt\n            title\n          }\n        }\n      }\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query storefrontAccessToken {\n    shop {\n      storefrontAccessTokens(first: 10) {\n        edges {\n          node {\n            id\n            accessToken\n            accessScopes {\n              handle\n            }\n            createdAt\n            title\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query storefrontAccessToken {\n    shop {\n      storefrontAccessTokens(first: 10) {\n        edges {\n          node {\n            id\n            accessToken\n            accessScopes {\n              handle\n            }\n            createdAt\n            title\n          }\n        }\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query storefrontAccessToken {\n    shop {\n      storefrontAccessTokens(first: 10) {\n        edges {\n          node {\n            id\n            accessToken\n            accessScopes {\n              handle\n            }\n            createdAt\n            title\n          }\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query storefrontAccessToken {\n  shop {\n    storefrontAccessTokens(first: 10) {\n      edges {\n        node {\n          id\n          accessToken\n          accessScopes {\n            handle\n          }\n          createdAt\n          title\n        }\n      }\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "shop": {
        "storefrontAccessTokens": {
          "edges": [
            {
              "node": {
                "id": "gid://shopify/StorefrontAccessToken/55270800",
                "accessToken": "678d97641255a4ab5feff997ee233f4c",
                "accessScopes": [
                  {
                    "handle": "unauthenticated_read_product_listings"
                  },
                  {
                    "handle": "unauthenticated_write_checkouts"
                  },
                  {
                    "handle": "unauthenticated_read_checkouts"
                  },
                  {
                    "handle": "unauthenticated_read_selling_plans"
                  }
                ],
                "createdAt": "2024-11-12T20:33:46Z",
                "title": "Buy Button Extension"
              }
            }
          ]
        }
      }
    }
  }

  Retrieves a list of the shop's policies

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query ShopPolicyList { shop { shopPolicies { id url body type title createdAt updatedAt } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query ShopPolicyList {\n    shop {\n      shopPolicies {\n        id\n        url\n        body\n        type\n        title\n        createdAt\n        updatedAt\n      }\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query ShopPolicyList {\n    shop {\n      shopPolicies {\n        id\n        url\n        body\n        type\n        title\n        createdAt\n        updatedAt\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query ShopPolicyList {\n    shop {\n      shopPolicies {\n        id\n        url\n        body\n        type\n        title\n        createdAt\n        updatedAt\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query ShopPolicyList {\n    shop {\n      shopPolicies {\n        id\n        url\n        body\n        type\n        title\n        createdAt\n        updatedAt\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query ShopPolicyList {\n  shop {\n    shopPolicies {\n      id\n      url\n      body\n      type\n      title\n      createdAt\n      updatedAt\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "shop": {
        "shopPolicies": [
          {
            "id": "gid://shopify/ShopPolicy/1",
            "url": "https://checkout.local/26371970/policies/1.html?locale=en",
            "body": "<p>The following is snowdevil's refund policy. blah blah blah blah blah.</p>",
            "type": "REFUND_POLICY",
            "title": "Refund policy",
            "createdAt": "2024-11-19T09:03:50-05:00",
            "updatedAt": "2024-11-19T09:03:50-05:00"
          },
          {
            "id": "gid://shopify/ShopPolicy/2",
            "url": "https://checkout.local/26371970/policies/2.html?locale=en",
            "body": "<p>PrivacyPolicy - this is a privacy policy document.</p>",
            "type": "PRIVACY_POLICY",
            "title": "Privacy policy",
            "createdAt": "2024-11-19T09:03:50-05:00",
            "updatedAt": "2024-11-19T09:03:50-05:00"
          },
          {
            "id": "gid://shopify/ShopPolicy/3",
            "url": "https://checkout.local/26371970/policies/3.html?locale=en",
            "body": "<p>Terms of Service - this is our terms of service</p>",
            "type": "TERMS_OF_SERVICE",
            "title": "Terms of service",
            "createdAt": "2024-11-19T09:03:50-05:00",
            "updatedAt": "2024-11-19T09:03:50-05:00"
          },
          {
            "id": "gid://shopify/ShopPolicy/4",
            "url": "https://checkout.local/26371970/policies/4.html?locale=en",
            "body": "<p>This is our Legal Notice</p>",
            "type": "LEGAL_NOTICE",
            "title": "Legal notice",
            "createdAt": "2024-11-19T09:03:50-05:00",
            "updatedAt": "2024-11-19T09:03:50-05:00"
          },
          {
            "id": "gid://shopify/ShopPolicy/5",
            "url": "https://checkout.local/26371970/policies/5.html?locale=en",
            "body": "<p>This is our Shipping Policy</p>",
            "type": "SHIPPING_POLICY",
            "title": "Shipping policy",
            "createdAt": "2024-11-19T09:03:50-05:00",
            "updatedAt": "2024-11-19T09:03:50-05:00"
          },
          {
            "id": "gid://shopify/ShopPolicy/6",
            "url": "https://checkout.local/26371970/policies/6.html?locale=en",
            "body": "<p>This is our Terms of Sale 🇫🇷</p>",
            "type": "TERMS_OF_SALE",
            "title": "Terms of sale",
            "createdAt": "2024-11-19T09:03:50-05:00",
            "updatedAt": "2024-11-19T09:03:50-05:00"
          },
          {
            "id": "gid://shopify/ShopPolicy/7",
            "url": "https://checkout.local/26371970/policies/7.html?locale=en",
            "body": "<p>This is our Subscription Policy</p>",
            "type": "SUBSCRIPTION_POLICY",
            "title": "Cancellation policy",
            "createdAt": "2024-11-19T09:03:50-05:00",
            "updatedAt": "2024-11-19T09:03:50-05:00"
          },
          {
            "id": "gid://shopify/ShopPolicy/8",
            "url": "https://checkout.local/26371970/policies/8.html?locale=en",
            "body": "<p>Contact Information - this is a contact information document.</p>",
            "type": "CONTACT_INFORMATION",
            "title": "Contact information",
            "createdAt": "2024-11-19T09:03:50-05:00",
            "updatedAt": "2024-11-19T09:03:50-05:00"
          }
        ]
      }
    }
  }