Back to Top

libraries > ShopifyGraphql.js

new ShopifyGraphql()

Graphql Library

Returns

Void

ShopifyGraphql.send(query, variables)

Grapqhl call to Shopify.

Parameters

Name Type Description
query string

Graphql query with variables.

variables object

Object with graphql query variables.

Examples

// Query example
const query = `query {
    shop {
      name
      primaryDomain {
        url
        host
      }
    }
   }`;
const rest =  Graphql.send(query, '');

Returns

object

Graphql response.

ShopifyGraphql.addOrUpdateMetafields(id, metafields)

Adds a metafields to Shopify order. This function will add a metafield id to the payload if metafield already exits.

Parameters

Name Type Description
id string

Shopify Order ID.

metafields Array.<Metafields>

Array of metafields.

Examples

const shopifyOrderId = 1234;
const metafields = [{
       namespace: "example",
       key: "example_key",
       value: "example_value"
   }];
const response =  Graphql.addOrUpdateMetafields(shopifyOrderId, metafields, "order");
Mesa.log.info('Graphql response: ', response);

Returns

object

Graphql response

ShopifyGraphql.addMetafields(id, metafields, entity)

Adds a metafield to a Shopify entity. This function will throw an error if metafield exists and you do not pass an id.

Parameters

Name Type Description
id string

Entity id.

metafields Array.<Metafields>

Array of metafields.

entity string

Entity: Order | Product

Returns

Void

ShopifyGraphql.groupMetafieldsByKey(data)

Takes metafield results, returns object keyed by the metafield key

Parameters

Name Type Description
data object

Returns

object

metafields

ShopifyGraphql.buildShopifyId(entity, id)

Builds Shopfiy Graphql id.

Parameters

Name Type Description
entity string

Shopfiy graphql entity.

id string

Shopify entity id.

Returns

string

Shopfiy graphql id

{Object} Metafields

Metafields

Properties

Name Type Description
id string

Metafield id.

Optional
key string

Metafield key.

namespace string

Metafield namespace.

value string

Metafield value.

valueType string

Metafield value type.

Optional