Script Specification

The most basic Mesa Script exports a class with a script() method. The code is executed in a V8 environment and can be written in standard Javascript or ES6. The class can contain additional methods or variables.

Parameters

During runtime, the script() method will be called and passed two parameters, payload and context:

Name

Name Type Description
payload object The payload data
context object Contains data relative to the current task that is running.
context.task object Metadata about the current Task that is executing. Available on: All Inputs and Outputs.
context.shop object Metadata about the Shopify store that the Task is running on
context.input object Metadata about the Input that triggered the Task. Available on: All Inputs. Optional
context.output object Metadata about the Output that triggered the Task. Available on: All Outputs. Optional
context.headers object The headers passed from the webhook. Available on: Shopify Webhook and JSON Webhook Inputs. Optional
context.filename object The name of the file that was read or is being saved on the FTP ServerAvailable on: FTP Inputs and FTP Outputs. Optional  

Basic Mesa Script

const Mesa = require('vendor/Mesa.js');

/**
 * A Mesa Script exports a class with a script() method.
 */
module.exports = new class {

  /**
   * Mesa Script
   *
   * @param {object} payload The payload data
   * @param {object} context Additional context about this task
   */
  script = (payload, context) => {

    // Your code goes here
  }
}

Mesa Scripts can call any of the Mesa SDK methods or methods from our libraries.

Timezones

All system timezones are in your Shopify Store's timezone.  You can view and update your timezone from the Shopify Dashboard: Admin > Settings > General, under "Standards and formats". If you need to get dates in a different timezone, use the Mesa.date.setTimezone(timezone) method.

Unsupported nodejs methods

Scripts are run in a stock V8 environment. This means that some common NodeJS methods are not available:
request(): Alternative: Mesa.request.*() Documentation.
console.log(): Alternative: Mesa.log.*() Documentation.
DOM manipulation methods: Alternative: Mesa.xml.decode() Documentation.