Shopify

learn how to connect engini to shopify getting started with shopify prerequisites a shopify account if you don’t have an account, create an account at www shopify com/signup connecting engini to shopify retrieve your shopify credentials log in to your shopify admin dashboard and navigate to the “apps” section click on the “app setting” button click on the “develop apps” button in the top right corner click on the “build apps in dev dashboard” button to enter shopify's dedicated app development environment click on the "create app" button in the top right corner of the dashboard to start setting up your custom application enter a unique name for your app in the "app name" field under start from dev dashboard , then click the "create" button right next to it select the permissions that you want to grant to your app and event version, for now choose 2026 04 provide your platform's endpoint link in the app url field to route operational communications and interface data correctly for example "https //enginistore com" click select scopes in the access section to define the specific data permissions required for your automated workflows check the boxes next to the data categories your workflows need to read or write, then click the white done button to apply them click "release" install app click the app name at the very top of the left hand menu to return to your main application overview page click the white install app button under the installs section in the top right to authorize and activate the app on your store click on the store you want to install you need to approve first the permissions of shopify scroll down the page and press "update" credentials click the "settings" option in the left hand navigation menu to access your newly created application credentials copy the client id and secret from the credentials section to authenticate the connection within engini add a connection to shopify in engini to connect your shopify account to engini, follow the next steps enter your engini account at https //app engini io https //app engini io/ navigate to connections page by clicking on the connections on the left sidebar or by clicking here https //app engini io/connections click on the new integration option located at the topbar choose shopify option from the available applications enter the following details in the “edit connection” form connection name – enter a descriptive and unique name for this connection shopify site url – enter your shopify store url make sure to include https // at the beginning client id – enter the client id from your shopify app credentials client secret – enter the client secret from your shopify app credentials save settings click on the save button located at the bottom of the form general information this section contains essential configurations for your shopify integration please ensure your connection settings are optimized to avoid data mismatches working with shopify metafields to successfully sync metafields with shopify, you must follow a strict structural workflow any deviation from this flow may result in failed api requests or metafields not being saved correct implementation flow initialize the metafields array https //help engini ai/transform and format#initialize variable create a variable and set its object element type to metafields this variable will hold all metafield objects append metafield objects https //help engini ai/transform and format#append to array variable use the append action to add metafields one by one each metafield object must include namespace key type value validate data types and formatting ensure that each metafield’s type and value strictly match shopify’s expected schema for example, list type metafields must be properly serialized (e g , arrays converted using tojsonstring) important shopify enforces strict validation on metafield structure and data types any mismatch will cause the request to fail silently or the data to be ignored if you encounter issues with specific metafield types or formatting, refer to the official shopify metafields api documentation shopify subscription plan field availability depends on your shopify subscription plan in basic plans, shopify restricts access to specific business data attempting to fetch restricted fields will result in errors or empty data common restricted fields in basic plans payment terms (id/name) typically available only for advanced/plus or b2b transactions staff member details of the staff member who processed the order required action within the output fields settings, ensure you uncheck or remove any fields not supported by your shopify plan (such as payment terms or staff member ) to prevent errors, select only standard fields like customer , total price , and line items triggers the trigger is executed automatically in response to a specific event every workflow has to start with a trigger you can use order, customer, refund and product triggers orders order created an order is created when a customer completes the checkout process, during which time they provide an email address, billing address and payment information listens for a new order creation add conditions click add conditions to define conditions that narrow down the data list and return only the relevant items to learn more about using filters, click here https //help engini ai/workflow editor#add conditions order updated listens for updates to an order based on specified conditions add conditions click add conditions to define conditions that narrow down the data list and return only the relevant items to learn more about using filters, click here https //help engini ai/workflow editor#add conditions order fulfilled listens for the fulfillment of an order based on your conditions in shopify, “order fulfilled” means that the order has been processed, and the items purchased by the customer have been shipped or are on their way to the customer add conditions click add conditions to define conditions that narrow down the data list and return only the relevant items to learn more about using filters, click here https //help engini ai/workflow editor#add conditions order paid listens for the order being paid, based on your conditions add conditions click add conditions to define conditions that narrow down the data list and return only the relevant items to learn more about using filters, click here https //help engini ai/workflow editor#add conditions order cancelled listens for the order being cancelled, based on your conditions add conditions click add conditions to define conditions that narrow down the data list and return only the relevant items to learn more about using filters, click here https //help engini ai/workflow editor#add conditions customers customer created listens for a new customer creation, based on your conditions add conditions click add conditions to define conditions that narrow down the data list and return only the relevant items to learn more about using filters, click here https //help engini ai/workflow editor#add conditions customer updated listens for customer’s updates, based on your conditions add conditions click add conditions to define conditions that narrow down the data list and return only the relevant items to learn more about using filters, click here https //help engini ai/workflow editor#add conditions refund refund created listens for refund creation, based on your conditions in shopify, “refund created” means that the seller has initiated the process of refunding the customer for a returned or cancelled order add conditions click add conditions to define conditions that narrow down the data list and return only the relevant items to learn more about using filters, click here https //help engini ai/workflow editor#add conditions products product created listens for a product creation, based on your conditions add conditions click add conditions to define conditions that narrow down the data list and return only the relevant items to learn more about using filters, click here https //help engini ai/workflow editor#add conditions product updated listens for a product’s updates add conditions click add conditions to define conditions that narrow down the data list and return only the relevant items to learn more about using filters, click here https //help engini ai/workflow editor#add conditions actions tags add tags now you can add tags to different objects tags the list of tags you want to assign to the object the format should be comma separated, like in the example click on the empty field and the tooltip will pop up showing the options you can choose you can populate the field in one of the following options static value – number / string when using strings, you need to surround them with single quotes (‘) property value from a previous activity (using the tooltip that opens when clicking on the field) expression – using functions https //help engini ai/enginis functions and/or previous activity properties and/or static values (using the tooltip that opens when clicking on the field) id the unique identifier of the object you want to tag it must be in shopify gid format, and can be used with customers, orders, draft orders and products click on the empty field and the tooltip will pop up showing the options you can choose you can populate the field in one of the following options static value – number / string when using strings, you need to surround them with single quotes (‘) property value from a previous activity (using the tooltip that opens when clicking on the field) products get product get one product to use the “get product” activity in engini you need to fill the id field product id click on the empty field and select the item id that is relevant output fields define which product properties are returned in the response the dropdown lists all available properties (for example, product title, description, variants, and images) selecting fields adds them to the response schema, while choosing all fields returns the full product object if no fields are selected, all properties are automatically included by default add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields get products output fields define which products properties are returned in the response the dropdown lists all available properties (for example, products title, descriptions and product id) selecting fields adds them to the response schema, while choosing all fields returns the full products object if no fields are selected, all properties are automatically included by default add filter click add filter to define conditions that narrow down the data list and return only the relevant items to learn more about using filters, click here https //help engini ai/workflow editor#add filters add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields create product creates a new product to use the “create product” activity block in engini you need to fill to following fields title the title is the name of the new product you create the title can come from the trigger or another action you performed in the process before the “create product” action click on the empty field and select the title of the new item you create you can use static value – number / string when using strings, you need to surround them with single quotes (‘) property value from a previous activity (using the tooltip that opens when clicking on the field) add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields note object array fields media \[], metafields \[], product options \[] each one of them is an array of objects the array is initialized using intialize object array, and each object is added to it with append to object array in case of a single object, the append to object array is not required update product product id click on the empty field select the item id that is relevant (note that you choose an id and not a name) you can use static value – number / string when using strings, you need to surround them with single quotes (‘) property value from a previous activity (using the tooltip that opens when clicking on the field) add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields note object array fields media \[], metafields \[] each one of them is an array of objects the array is initialized using intialize object array, and each object is added to it with append to object array in case of a single object, the append to object array is not required object array initialize object array this activity initializes an object array in shopify and stores a single structured entry based on the selected object type (e g fulfillment order line items ,line items) variable name enter the name of the variable that will hold the initialized object array this name will be used throughout the workflow whenever you refer to this object array object element type this field defines the type of data the array will store, such as fulfillment order line items ,line items the selected type determines the structure of the array and its use in subsequent actions add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields append to object array append to object array is used to add new elements into an array of objects this action is directly connected to initialize object array variable dropdown that lists all object arrays initialized in previous steps of the workflow here you select the specific array to which a new object will be appended add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields map array the map array activity allows you to transform an object that contains multiple pieces of data into a new data list based on the fileds and values you choose object name select the object you want to map the available options are the same objects that were previously initialized using initialize object array data list the data provided here must match the structure of the selected object name once the object is chosen, you will be able to add fields that correspond to the fields defined in that object add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields inventory get inventory item get one inventory item to use the “get inventory item” activity in engini you need to fill the id field inventory item id click on the empty field select the item id that is relevant output fields define which inventory item properties are returned in the response the dropdown lists all available properties (for example, inventory item id, description, quantities, and images) selecting fields adds them to the response schema, while choosing all fields returns the full inventory item object if no fields are selected, all properties are automatically included by default add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields update inventory item inventory item id the id of the inventory item you want to update add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields update inventory level in shopify, the inventory level represents the actual quantity of an item available at a specific location ignore compare quantity a boolean indicating whether shopify should skip the comparison against the current stock quantity if false, the update will proceed regardless of mismatched values quantities \[] this expects an array of objects to build it, you must first initialize an object array and then append elements using append to object array each object in this array represents one inventory update each element you append to the quantities array includes the following fields inventory item id – the unique identifier of the inventory item you want to update compare quantity – the current stock level you expect to see in shopify before the update used for concurrency control location id – the id of the location (warehouse or store) where this inventory change applies quantity – the new stock level you want to set for the item at the given location the name of quantities the label or identifier for the quantities array, used internally in the workflow to reference this object can be “available” or “on hand” the reason for the quantity changes an enum field to specify why the inventory level was modified (for example “restock”, “other”, or “correction” and some more) order get order order id the id of the order item you want to get output fields define which inventory item properties are returned in the response the dropdown lists all available properties (for example, inventory item id, description, quantities, and images) selecting fields adds them to the response schema, while choosing all fields returns the full inventory item object if no fields are selected, all properties are automatically included by default to more information about shopify subscription plan for this action , discounted plan subscribers cannot select the fields payment terms – id staff member – email staff member – id staff member – name staff member – phone add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields create order tax lines \[] an array of tax details applied to the order each tax line can include information such as the tax rate, title (e g , “vat”), and the amount charged transactions \[] a list of payment transactions related to the order each transaction can include details such as the payment method, amount, and status this is required when recording how the order was paid (e g , credit card, paypal, shop money) add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields note object array fields custom attributes \[], line items \[], metafields \[] each one of them is an array of objects the array is initialized using initialize object array, and each object is added to it with append to object array in case of a single object, the append to object array is not required update order order id the id of the order you want to update add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields note object array fields custom attributes \[], metafields \[], localized fields \[] each one of them is an array of objects the array is initialized using initialize object array, and each object is added to it with append to object array in case of a single object, the append to object array is not required variant get variant specific version of a product that has a unique combination of attributes such as size, color, material, and price variant id the id of the variant you want to get output fields define which variant properties are returned in the response the dropdown lists all available properties (for example, variant title, description and images) selecting fields adds them to the response schema, while choosing all fields returns the full variant object if no fields are selected, all properties are automatically included by default add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields create variant product id the id of the product for which you want to create a variant variants \[] is an array of objects each object represents a single variant of the product to create a variant, you must provide the required fields inside the object the array is initialized using initialize object array, and each variant object is added to it with append to object array without filling in the object, the variant cannot be created you can populate the field in one of the following options static value – number / string when using strings, you need to surround them with single quotes (‘) property value from a previous activity (using the tooltip that opens when clicking on the field) add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields note object array field media \[] each one of them is an array of objects the array is initialized using initialize object array, and each object is added to it with append to object array in case of a single object, the append to object array is not required update variant product id the id of the product whose variants you wish to update add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields note object array fields media \[], variants \[] each one of them is an array of objects the array is initialized using initialize object array, and each object is added to it with append to object array in case of a single object, the append to object array is not required transactions in shopify, a transaction refers to any payment or refund that is associated with an order get transactions output fields define which transactions properties are returned in the response the dropdown lists all available properties (for example, order id, description and transaction id) selecting fields adds them to the response schema, while choosing all fields returns the full transaction object if no fields are selected, all properties are automatically included by default add filter click add filter to define conditions that narrow down the data list and return only the relevant items to learn more about using filters, click here https //help engini ai/workflow editor#add filters add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields location in shopify, a location refers to a physical address or place associated with the management of inventory and fulfillment get location location id the id of the location you want to get output fields define which location properties are returned in the response the dropdown all available properties (for example, location title, description and images) selecting fields adds them to the response schema, while choosing all fields returns the full location object if no fields are selected, all properties are automatically included by default add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields get locations output fields define which locations properties are returned in the response the dropdown lists all available properties (for example, location title, description and location id) selecting fields adds them to the response schema, while choosing all fields returns the full location object if no fields are selected, all properties are automatically included by default add filter click add filter to define conditions that narrow down the data list and return only the relevant items to learn more about using filters, click here https //help engini ai/workflow editor#add filters add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields price lists a price list in shopify is a collection of product prices that can be applied to specific customers or markets, allowing the system to display and use those defined prices instead of the default ones get price lists output fields define which price lists properties are returned in the response the dropdown lists all available properties (for example, title, description and price list id) selecting fields adds them to the response schema, while choosing all fields returns the full price list object if no fields are selected, all properties are automatically included by default add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields create price list currency defines the currency in which the price list will be created by default, in our setup this will be set to ils parent – adjustment – type specifies the type of price adjustment that will be applied relative to the parent price list for example, whether the adjustment is a percentage increase or decrease parent – adjustment – value defines the numeric value of the adjustment depending on the type selected above, this can represent either the percentage to increase/decrease or the fixed amount to add/subtract from the parent price add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields update price list price list id the id of the price list you want to update his price list add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields customers a customer in shopify is a record that stores basic information about a person or company that has interacted with the store, such as their name, contact details, and order history get customers output fields define which customers properties are returned in the response the dropdown lists all available properties (for example, name, address details and customer id) selecting fields adds them to the response schema, while choosing all fields returns the full customers object if no fields are selected, all properties are automatically included by default add filter click add filter to define conditions that narrow down the data list and return only the relevant items to learn more about using filters, click here https //help engini ai/workflow editor#add filters add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields create customer add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields note object array fields addresses \[], metafields \[] each one of them is an array of objects the array is initialized using initialize object array, and each object is added to it with append to object array in case of a single object, the append to object array is not required update customer customer id the id of the customer you want to update add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields note object array fields addresses \[], metafields \[] each one of them is an array of objects the array is initialized using initialize object array, and each object is added to it with append to object array in case of a single object, the append to object array is not required draft order a draft order in shopify is a preliminary order created by the store owner or staff, which can be saved, updated, and later converted into a completed order complete draft order in shopify, complete draft order means finalizing a draft order so that it becomes a regular order in the store once completed, the draft order is no longer editable as a draft, it moves into the standard orders list, payment can be recorded, and the order is treated like any other confirmed purchase draft order id the id of the draft order you want to make a real order add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields receive a single draft order draft order id the id of the draft order you want to get output fields define which draft order properties are returned in the response the dropdown lists all available properties (for example, draft order id, tags, quantities, and updated at) selecting fields adds them to the response schema, while choosing all fields returns the full draft order object if no fields are selected, all properties are automatically included by default add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields retrieves a list of a draft orders output fields define which draft orders properties are returned in the response the dropdown lists all available properties (for example, status, tags and draft order id) selecting fields adds them to the response schema, while choosing all fields returns the full draft orders object if no fields are selected, all properties are automatically included by default add filter click add filter to define conditions that narrow down the data list and return only the relevant items to learn more about using filters, click here https //help engini ai/workflow editor#add filters add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields modify an existing draft order draft order id the id of the draft order you want to update add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields note object array fields custom attributes \[], line items \[], localized fields \[], metafields \[], payment schedules \[] each one of them is an array of objects the array is initialized using intialize object array, and each object is added to it with append to object array in case of a single object, the append to object array is not required create draft order to create a draft order you must add fields, it cannot be created completely empty however, there are no mandatory fields, so you can choose which details to include add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields note object array fields custom attributes \[], discount codes \[], line items \[], localized fields \[], metafields \[], payment schedules \[] each one of them is an array of objects the array is initialized using intialize object array, and each object is added to it with append to object array in case of a single object, the append to object array is not required remove an existing draftorder draft order id the id of the draft order you want to remove fulfillments retrieve specific fulfillment order fulfillment order id the id of the fulfillment order you want to get output fields define which fulfillment order properties are returned in the response the dropdown lists all available properties (for example, fulfillment order id, tax info and total weight) selecting fields adds them to the response schema, while choosing all fields returns the full fulfillment order object if no fields are selected, all properties are automatically included by default add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields retrieves a list of fulfillment order for a specific order order id the id of the order you want to get the fulfillments of the order output fields define which order properties are returned in the response the dropdown lists all available properties (for example, order id, channel id, and status) selecting fields adds them to the response schema, while choosing all fields returns the full order object if no fields are selected, all properties are automatically included by default add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields create a fulfillment add parameter click add parameter to add and populate additional fields for the selected activity to learn more about managing activity data, click here https //help engini ai/workflow editor#add fields note object array field fulfillment order \[] each one of them is an array of objects the array is initialized using intialize object array, and each object is added to it with append to object array in case of a single object, the append to object array is not required