(Excel) 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

Download Excel Class Modules Chilkat Excel Class Modules

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

Dim http As Chilkat.Http
Set http = Chilkat.NewHttp

' 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"


Set resp = http.PText("POST",url,query,"utf-8","application/graphql",False,False)
If (http.LastMethodSuccess <> True) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

' Examine the response code.
If (resp.StatusCode <> 200) Then
    Debug.Print "Received error response code: "; resp.StatusCode
    Debug.Print "Response body:"
    Debug.Print resp.BodyStr

    Exit Sub
End If

Dim sbResponseBody As Chilkat.StringBuilder
Set sbResponseBody = Chilkat.NewStringBuilder
Dim success As Boolean
success = resp.GetBodySb(sbResponseBody)
Dim jResp As Chilkat.JsonObject
Set jResp = Chilkat.NewJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.Print "Response Body:"
Debug.Print jResp.Emit()


respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = "; respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print resp.Header
    Debug.Print "Failed."

    Exit Sub
End If

' 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")

Debug.Print "Shop name: "; shopName
' ...