(PowerShell) Shopify GraphQL Simple Query (Get Shop Object)

See more Shopify Examples

Demonstrates a simple Shopify GraphQL query to get specific fields of the Shop object.

For more information, see https://www.shopify.com/partners/blog/shopify-graphql-learning-kit#query-structure

Chilkat .NET Downloads Chilkat .NET Assemblies

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$http = New-Object Chilkat.Http

# This example will use private authentication (which is HTTP Basic authentication)
# See the other Chilkat Shopify examples for OAuth2 authentication.
# To use HTTP Basic Authentication with any HTTP request, we simply set the Login, Password, and BasicAuth properties.
# Important: All HTTP requests using Basic authentication must be over SSL/TLS.
$http.Login = "SHOPIFY_PRIVATE_API_KEY"
$http.Password = "SHOPIFY_PRIVATE_API_SECRET_KEY"
$http.BasicAuth = $true

# We're going to do a POST  https://{shop}.myshopify.com/admin/api/2021-04/graphql.json
# Make sure to replace "chilkat" with your store name.

# The body of the request will be:
#    {
#        shop {
#            id
#            name
#            description
#            email
#         }
#     }

# The above query is not JSON.  It looks like JSON, but it's actually not.
# We'll just make it one line:

$query = "{ shop { id name description email } }"

# My store name is "chilkat".  Use your store name here instead.
$url = "https://chilkat.myshopify.com/admin/api/2021-04/graphql.json"

$resp = $http.PText("POST",$url,$query,"utf-8","application/graphql",$false,$false)
if ($http.LastMethodSuccess -ne $true) {
    $($http.LastErrorText)
    exit
}

# Examine the response code.
if ($resp.StatusCode -ne 200) {
    $("Received error response code: " + $resp.StatusCode)
    $("Response body:")
    $($resp.BodyStr)

    exit
}

$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($resp.Header)
    $("Failed.")

    exit
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "data": {
#     "shop": {
#       "id": "gid:\/\/shopify\/Shop\/24198053",
#       "name": "chilkat",
#       "description": null,
#       "email": "admin@chilkatsoft.com"
#     }
#   },
#   "extensions": {
#     "cost": {
#       "requestedQueryCost": 1,
#       "actualQueryCost": 1,
#       "throttleStatus": {
#         "maximumAvailable": 1000.0,
#         "currentlyAvailable": 999,
#         "restoreRate": 50.0
#       }
#     }
#   }
# }

# Sample code for parsing the JSON response...
# Use the following online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON

$shopId = $jResp.StringOf("data.shop.id")
$shopName = $jResp.StringOf("data.shop.name")
$shopDescription = $jResp.StringOf("data.shop.description")
$shopEmail = $jResp.StringOf("data.shop.email")
$costRequestedQueryCost = $jResp.IntOf("extensions.cost.requestedQueryCost")
$costActualQueryCost = $jResp.IntOf("extensions.cost.actualQueryCost")
$costThrottleStatusMaximumAvailable = $jResp.StringOf("extensions.cost.throttleStatus.maximumAvailable")
$costThrottleStatusCurrentlyAvailable = $jResp.IntOf("extensions.cost.throttleStatus.currentlyAvailable")
$costThrottleStatusRestoreRate = $jResp.StringOf("extensions.cost.throttleStatus.restoreRate")

$("Shop name: " + $shopName)
# ...