(Tcl) 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 Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set http [new_CkHttp]

# 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.
CkHttp_put_Login $http "SHOPIFY_PRIVATE_API_KEY"
CkHttp_put_Password $http "SHOPIFY_PRIVATE_API_SECRET_KEY"
CkHttp_put_BasicAuth $http 1

# 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:

set query "{ shop { id name description email } }"

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

# resp is a CkHttpResponse
set resp [CkHttp_PText $http "POST" $url $query "utf-8" "application/graphql" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] != 1} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    exit
}

# Examine the response code.
if {[CkHttpResponse_get_StatusCode $resp] != 200} then {
    puts "Received error response code: [CkHttpResponse_get_StatusCode $resp]"
    puts "Response body:"
    puts [CkHttpResponse_bodyStr $resp]
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

# 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

set shopId [CkJsonObject_stringOf $jResp "data.shop.id"]
set shopName [CkJsonObject_stringOf $jResp "data.shop.name"]
set shopDescription [CkJsonObject_stringOf $jResp "data.shop.description"]
set shopEmail [CkJsonObject_stringOf $jResp "data.shop.email"]
set costRequestedQueryCost [CkJsonObject_IntOf $jResp "extensions.cost.requestedQueryCost"]
set costActualQueryCost [CkJsonObject_IntOf $jResp "extensions.cost.actualQueryCost"]
set costThrottleStatusMaximumAvailable [CkJsonObject_stringOf $jResp "extensions.cost.throttleStatus.maximumAvailable"]
set costThrottleStatusCurrentlyAvailable [CkJsonObject_IntOf $jResp "extensions.cost.throttleStatus.currentlyAvailable"]
set costThrottleStatusRestoreRate [CkJsonObject_stringOf $jResp "extensions.cost.throttleStatus.restoreRate"]

puts "Shop name: $shopName"
# ...

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp