(PHP Extension) 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 PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

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

$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->put_Login('SHOPIFY_PRIVATE_API_KEY');
$http->put_Password('SHOPIFY_PRIVATE_API_SECRET_KEY');
$http->put_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 is a CkHttpResponse
$resp = $http->PText('POST',$url,$query,'utf-8','application/graphql',false,false);
if ($http->get_LastMethodSuccess() != true) {
    print $http->lastErrorText() . "\n";
    exit;
}

// Examine the response code.
if ($resp->get_StatusCode() != 200) {
    print 'Received error response code: ' . $resp->get_StatusCode() . "\n";
    print 'Response body:' . "\n";
    print $resp->bodyStr() . "\n";

    exit;
}

$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->header() . "\n";
    print 'Failed.' . "\n";

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

print 'Shop name: ' . $shopName . "\n";
// ...

?>