Dart Requires Chilkat v11.0.0+

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

import 'package:chilkat/chilkat.dart';

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

  final http = 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:

  final query = '{ shop { id name description email } }';

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

  final resp = CkHttpResponse();
  try {
    http.httpStr('POST', url, query, 'utf-8', 'application/graphql', resp);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Examine the response code.
  if (resp.statusCode != 200) {
    print('Received error response code: ${resp.statusCode}');
    print('Response body:');
    print(resp.bodyStr);
    return;
  }

  final sbResponseBody = CkStringBuilder();
  resp.getBodySb(sbResponseBody);
  final jResp = CkJsonObject();
  jResp.loadSb(sbResponseBody);
  jResp.emitCompact = false;

  print('Response Body:');
  print(jResp.emit());

  final respStatusCode = resp.statusCode;
  print('Response Status Code = $respStatusCode');
  if (respStatusCode >= 400) {
    print('Response Header:');
    print(resp.header);
    print('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

  final shopId = jResp.stringOf('data.shop.id');
  final shopName = jResp.stringOf('data.shop.name');
  final shopDescription = jResp.stringOf('data.shop.description');
  final shopEmail = jResp.stringOf('data.shop.email');
  final costRequestedQueryCost = jResp.intOf('extensions.cost.requestedQueryCost');
  final costActualQueryCost = jResp.intOf('extensions.cost.actualQueryCost');
  final costThrottleStatusMaximumAvailable = jResp.stringOf('extensions.cost.throttleStatus.maximumAvailable');
  final costThrottleStatusCurrentlyAvailable = jResp.intOf('extensions.cost.throttleStatus.currentlyAvailable');
  final costThrottleStatusRestoreRate = jResp.stringOf('extensions.cost.throttleStatus.restoreRate');

  print('Shop name: $shopName');
  // ...
}