JavaScript

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. JavaScript

var success = false;

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

var 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.
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:

var query = "{ shop { id name description email } }";

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

var resp = new CkHttpResponse();
success = http.HttpStr("POST",url,query,"utf-8","application/graphql",resp);
if (success == false) {
    console.log(http.LastErrorText);
    return;
}

// Examine the response code.
if (resp.StatusCode !== 200) {
    console.log("Received error response code: " + resp.StatusCode);
    console.log("Response body:");
    console.log(resp.BodyStr);
    return;
}

var sbResponseBody = new CkStringBuilder();
resp.GetBodySb(sbResponseBody);
var jResp = new CkJsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

console.log("Response Body:");
console.log(jResp.Emit());

var respStatusCode = resp.StatusCode;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
    console.log("Response Header:");
    console.log(resp.Header);
    console.log("Failed.");
    return;
}

// 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

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

console.log("Shop name: " + shopName);
// ...