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

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    success.i = 0

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ;  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::setCkLogin(http, "SHOPIFY_PRIVATE_API_KEY")
    CkHttp::setCkPassword(http, "SHOPIFY_PRIVATE_API_SECRET_KEY")
    CkHttp::setCkBasicAuth(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:

    query.s = "{ shop { id name description email } }"

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

    resp.i = CkHttpResponse::ckCreate()
    If resp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckHttpStr(http,"POST",url,query,"utf-8","application/graphql",resp)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(resp)
        ProcedureReturn
    EndIf

    ;  Examine the response code.
    If CkHttpResponse::ckStatusCode(resp) <> 200
        Debug "Received error response code: " + Str(CkHttpResponse::ckStatusCode(resp))
        Debug "Response body:"
        Debug CkHttpResponse::ckBodyStr(resp)
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(resp)
        ProcedureReturn
    EndIf

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(resp)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    ;  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.s = CkJsonObject::ckStringOf(jResp,"data.shop.id")
    shopName.s = CkJsonObject::ckStringOf(jResp,"data.shop.name")
    shopDescription.s = CkJsonObject::ckStringOf(jResp,"data.shop.description")
    shopEmail.s = CkJsonObject::ckStringOf(jResp,"data.shop.email")
    costRequestedQueryCost.i = CkJsonObject::ckIntOf(jResp,"extensions.cost.requestedQueryCost")
    costActualQueryCost.i = CkJsonObject::ckIntOf(jResp,"extensions.cost.actualQueryCost")
    costThrottleStatusMaximumAvailable.s = CkJsonObject::ckStringOf(jResp,"extensions.cost.throttleStatus.maximumAvailable")
    costThrottleStatusCurrentlyAvailable.i = CkJsonObject::ckIntOf(jResp,"extensions.cost.throttleStatus.currentlyAvailable")
    costThrottleStatusRestoreRate.s = CkJsonObject::ckStringOf(jResp,"extensions.cost.throttleStatus.restoreRate")

    Debug "Shop name: " + shopName
    ;  ...


    CkHttp::ckDispose(http)
    CkHttpResponse::ckDispose(resp)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure