Covered in this article
Shopify-component pages
Shopify Admin actions. Shopify Admin Changelog Completeness Matrix Shopify Admin triggers.
Created on Updated on
Shopify Admin component

Shopify Admin component

A component to work with the Shopify Admin API.

Latest changelog

1.4.0 (Sept 11, 2020)

  • Add support for reading & writing metafields
  • Bump dependencies
  • Change API Key in credentials to password level
  • Remove sensitive info from logs

To see the full changelog please use the following link.

How works. API version

Component was tested on 2019-10 API version.

You can find more information about API versioning at Shopify here.

Shopify Admin API documentation.

Requirements

Credentials

  • shopName
  • apiKey
  • password

Please Note: How to generate creds

Environment variables

Name Mandatory Description Values
SHOPIFY_API_VERSION false Determines API version of Shopify to use Default: 2019-10

Metafield Notes

Metafields for an object can be written when upserting/creating an object that supports metafields. When polling for objects, looking up an object or searching for objects, there is a checkbox that can be selected that will fetch the corresponding metafields for objects. Selecting this checkbox will cause more API calls to be consumed. (An additional API call per object read.)

When reading metafields data will be returned in this format. When writing metafield data, the following format is also expected for the metafields object.

{
  "metafieldNamespaceOne" : {
    "metafieldKeyOne": "Metafield Value for metafieldNamespaceOne.metafieldKeyOne",
    "metafieldKeyTwo": "Metafield Value for metafieldNamespaceOne.metafieldKeyTwo"
  },
  "metafieldNamespaceTwo": {
    "metafieldKeyThree": "Metafield Value for metafieldNamespaceTwo.metafieldKeyThree"
  }
}

Shopify metafields support the following three types:

  • integer metafields will be created whenever the value provided for a metafield is a JSON number that is an integer. When reading Shopify integer metafields, they will result in JSON numbers.

  • string metafields will be created whenever the value provided for a metafield is a JSON string or a JSON number that is not an integer. When reading any Shopify string metafields, they will result in JSON strings regardless of whether or not they could be parsed as numbers.

  • json_string metafields will be created whenever the value provided for a metafield is a JSON object, array or boolean. The incoming value will be converted to a JSON string and stored. When reading Shopify metafields, they will be converted back to their JSON forms.

Setting a metafield the value of JSON null will result in that metafield being deleted.

Not setting a value for a metafield will result in that metafield being unchanged.

Completeness Matrix

The component completeness matrix gives the technical details about Salesforce objects this component covers.

Triggers

Shopify Admin component includes the following triggers:

  1. Polling Trigger
    Polls Shopify API for new and updated objects.

  2. Webhook subscription trigger
    Creates webhook subscriptions on the Shopify side and receives events to the flow.

Actions

Shopify Admin component includes the following actions:

  1. Lookup Object action
    Finds object by id.

  2. Lookup Objects action
    Retrieves object by ID.

  3. Create Object action
    Action to create new object instance. Only for object that can’t be updated.

  4. Upsert Object action
    Upsert Object action is useful if it isn’t known if there is already an object in the system. Action determines if the data needs to be matched to an existing object or added to a new one. Only for objects that can be created and updated.

  5. Delete Object action
    Delete Object By Unique Criteria

The following Shopify Admin actions are deprecated:

  1. List Products(deprecated)
    This actions is deprecated. Use Lookup Object action instead.

  2. Upsert Product(deprecated)
    This actions is deprecated. Use Upsert Objects action instead.

  3. Delete Product(deprecated)
    This actions is deprecated. Use Upsert Objects action instead.

  4. Get Product(deprecated)
    This actions is deprecated. Use Lookup Object action instead.

  5. Count Products(deprecated)
    This actions is deprecated. Use Delete Object action instead.

  6. Create Product Image(deprecated)
    This actions is deprecated. Use Upsert Object action instead.

  7. Update Product Image(deprecated)
    This actions is deprecated. Use Upsert Object action instead.

  8. Delete Product Image(deprecated)
    This actions is deprecated. Use Upsert Object action instead.

  9. List Inventory Items(deprecated)
    This actions is deprecated. Use Lookup Object action instead.

  10. Get Inventory Item(deprecated)
    This actions is deprecated. Use Lookup Object action instead.

  11. Update Inventory Item(deprecated)
    This actions is deprecated. Use Upsert Object action instead.

  12. Create Product Variant(deprecated)
    This actions is deprecated. Use Upsert Object action instead.

  13. Update Product Variant(deprecated)
    This actions is deprecated. Use Upsert Object action instead.

  14. Delete Product Variant(deprecated)
    This actions is deprecated. Use Upsert Object action instead.

Shopify Admin API documentation

How to generate creds