Shopify

Shopify is an e-commerce platform that allows businesses to create online stores and sell products.

Categories: e-commerce

Type: shopify/v1

---

Connections

Version: 1

API Key

Properties

Name	Label	Type	Control Type	Description	Required
shopName	Shop name	STRING	TEXT		true
key	Access token	STRING	TEXT		true
value	Access Token	STRING	TEXT		true

---

Actions

Create Order

Name: createOrder

Adds an order into a Shopify store.

Properties

Name	Label	Type	Control Type	Description	Required
__item	Order	OBJECT Properties {{[{STRING(fulfillment_status), STRING(grams), NUMBER(price), INTEGER(product_id), INTEGER(variant_id), INTEGER(quantity), STRING(title)}](line_items), STRING(total_tax), STRING(currency)}(order)}	OBJECT_BUILDER		null

Output

Type: OBJECT

Properties

Name	Type	Control Type
id	INTEGER	INTEGER
currency	STRING	TEXT
note	STRING	TEXT
email	STRING	TEXT
name	STRING	TEXT
phone	STRING	TEXT
tags	STRING	TEXT
line_items	ARRAY Items [{STRING(fulfillment_status), STRING(grams), NUMBER(price), INTEGER(product_id), INTEGER(variant_id), INTEGER(quantity), STRING(title)}]	ARRAY_BUILDER

JSON Example

{
  "label" : "Create Order",
  "name" : "createOrder",
  "parameters" : {
    "__item" : {
      "order" : {
        "line_items" : [ {
          "fulfillment_status" : "",
          "grams" : "",
          "price" : 0.0,
          "product_id" : 1,
          "variant_id" : 1,
          "quantity" : 1,
          "title" : ""
        } ],
        "total_tax" : "",
        "currency" : ""
      }
    }
  },
  "type" : "shopify/v1/createOrder"
}

Delete Order

Name: deleteOrder

Deletes an order. Orders that interact with an online gateway can’t be deleted.

Properties

Name	Label	Type	Control Type	Description	Required
orderId	Order ID	INTEGER	SELECT	ID of the order to delete.	true

JSON Example

{
  "label" : "Delete Order",
  "name" : "deleteOrder",
  "parameters" : {
    "orderId" : 1
  },
  "type" : "shopify/v1/deleteOrder"
}

Cancel an order

Name: cancelOrder

Cancels an order. Orders that are paid and have fulfillments can’t be canceled.

Properties

Name	Label	Type	Control Type	Description	Required
orderId	Order ID	INTEGER	SELECT	ID of the order to cancel.	true

Output

Type: OBJECT

Properties

Name	Type	Control Type
id	INTEGER	INTEGER
currency	STRING	TEXT
note	STRING	TEXT
email	STRING	TEXT
name	STRING	TEXT
phone	STRING	TEXT
tags	STRING	TEXT
line_items	ARRAY Items [{STRING(fulfillment_status), STRING(grams), NUMBER(price), INTEGER(product_id), INTEGER(variant_id), INTEGER(quantity), STRING(title)}]	ARRAY_BUILDER

JSON Example

{
  "label" : "Cancel an order",
  "name" : "cancelOrder",
  "parameters" : {
    "orderId" : 1
  },
  "type" : "shopify/v1/cancelOrder"
}

Update Order

Name: updateOrder

Update an existing order.

Properties

Name	Label	Type	Control Type	Description	Required
orderId	Order ID	INTEGER	SELECT	ID of the order to update.	true
__item	Order	OBJECT Properties {{STRING(note), STRING(email), STRING(phone), STRING(tags)}(order)}	OBJECT_BUILDER		null

Output

Type: OBJECT

Properties

Name	Type	Control Type
id	INTEGER	INTEGER
currency	STRING	TEXT
note	STRING	TEXT
email	STRING	TEXT
name	STRING	TEXT
phone	STRING	TEXT
tags	STRING	TEXT
line_items	ARRAY Items [{STRING(fulfillment_status), STRING(grams), NUMBER(price), INTEGER(product_id), INTEGER(variant_id), INTEGER(quantity), STRING(title)}]	ARRAY_BUILDER

JSON Example

{
  "label" : "Update Order",
  "name" : "updateOrder",
  "parameters" : {
    "orderId" : 1,
    "__item" : {
      "order" : {
        "note" : "",
        "email" : "",
        "phone" : "",
        "tags" : ""
      }
    }
  },
  "type" : "shopify/v1/updateOrder"
}

Close Order

Name: closeOrder

Closes an order. A closed order is one that has no more work to be done. All items have been fulfilled or refunded.

Properties

Name	Label	Type	Control Type	Description	Required
orderId	Order ID	INTEGER	SELECT	ID of the order to close.	true

Output

Type: OBJECT

Properties

Name	Type	Control Type
id	INTEGER	INTEGER
currency	STRING	TEXT
note	STRING	TEXT
email	STRING	TEXT
name	STRING	TEXT
phone	STRING	TEXT
tags	STRING	TEXT
line_items	ARRAY Items [{STRING(fulfillment_status), STRING(grams), NUMBER(price), INTEGER(product_id), INTEGER(variant_id), INTEGER(quantity), STRING(title)}]	ARRAY_BUILDER

JSON Example

{
  "label" : "Close Order",
  "name" : "closeOrder",
  "parameters" : {
    "orderId" : 1
  },
  "type" : "shopify/v1/closeOrder"
}

Triggers

New Cancelled Order

Name: newCancelledOrder

Triggers when order is cancelled.

Type: DYNAMIC_WEBHOOK

Output

Type: OBJECT

Properties

Name	Type	Control Type
id	INTEGER	INTEGER
currency	STRING	TEXT
note	STRING	TEXT
email	STRING	TEXT
name	STRING	TEXT
phone	STRING	TEXT
tags	STRING	TEXT
line_items	ARRAY Items [{STRING(fulfillment_status), STRING(grams), NUMBER(price), INTEGER(product_id), INTEGER(variant_id), INTEGER(quantity), STRING(title)}]	ARRAY_BUILDER

JSON Example

{
  "label" : "New Cancelled Order",
  "name" : "newCancelledOrder",
  "type" : "shopify/v1/newCancelledOrder"
}

New Order

Name: newOrder

Triggers when new order is created.

Type: DYNAMIC_WEBHOOK

Output

Type: OBJECT

Properties

Name	Type	Control Type
id	INTEGER	INTEGER
currency	STRING	TEXT
note	STRING	TEXT
email	STRING	TEXT
name	STRING	TEXT
phone	STRING	TEXT
tags	STRING	TEXT
line_items	ARRAY Items [{STRING(fulfillment_status), STRING(grams), NUMBER(price), INTEGER(product_id), INTEGER(variant_id), INTEGER(quantity), STRING(title)}]	ARRAY_BUILDER

JSON Example

{
  "label" : "New Order",
  "name" : "newOrder",
  "type" : "shopify/v1/newOrder"
}

New Paid Order

Name: newPaidOrder

Triggers when paid order is created.

Type: DYNAMIC_WEBHOOK

Output

Type: OBJECT

Properties

Name	Type	Control Type
id	INTEGER	INTEGER
currency	STRING	TEXT
note	STRING	TEXT
email	STRING	TEXT
name	STRING	TEXT
phone	STRING	TEXT
tags	STRING	TEXT
line_items	ARRAY Items [{STRING(fulfillment_status), STRING(grams), NUMBER(price), INTEGER(product_id), INTEGER(variant_id), INTEGER(quantity), STRING(title)}]	ARRAY_BUILDER

JSON Example

{
  "label" : "New Paid Order",
  "name" : "newPaidOrder",
  "type" : "shopify/v1/newPaidOrder"
}

---

---

Additional instructions

---

CONNECTION