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	Required
shopName	Shop name	STRING	true
key	Access token	STRING	true
value	Access Token	STRING	true

Actions

Create Order

Name: createOrder

Adds an order into a Shopify store.

Properties

Name	Label	Type	Description	Required
order	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)}		false

Example JSON Structure

{
  "label" : "Create Order",
  "name" : "createOrder",
  "parameters" : {
    "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"
}

Output

Type: OBJECT

Properties

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

Output Example

{
  "id" : 1,
  "currency" : "",
  "note" : "",
  "email" : "",
  "name" : "",
  "phone" : "",
  "tags" : "",
  "line_items" : [ {
    "fulfillment_status" : "",
    "grams" : "",
    "price" : 0.0,
    "product_id" : 1,
    "variant_id" : 1,
    "quantity" : 1,
    "title" : ""
  } ]
}

Delete Order

Name: deleteOrder

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

Properties

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

Example JSON Structure

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

Output

This action does not produce any output.

Cancel an order

Name: cancelOrder

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

Properties

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

Example JSON Structure

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

Output

Type: OBJECT

Properties

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

Output Example

{
  "id" : 1,
  "currency" : "",
  "note" : "",
  "email" : "",
  "name" : "",
  "phone" : "",
  "tags" : "",
  "line_items" : [ {
    "fulfillment_status" : "",
    "grams" : "",
    "price" : 0.0,
    "product_id" : 1,
    "variant_id" : 1,
    "quantity" : 1,
    "title" : ""
  } ]
}

Update Order

Name: updateOrder

Update an existing order.

Properties

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

Example JSON Structure

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

Output

Type: OBJECT

Properties

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

Output Example

{
  "id" : 1,
  "currency" : "",
  "note" : "",
  "email" : "",
  "name" : "",
  "phone" : "",
  "tags" : "",
  "line_items" : [ {
    "fulfillment_status" : "",
    "grams" : "",
    "price" : 0.0,
    "product_id" : 1,
    "variant_id" : 1,
    "quantity" : 1,
    "title" : ""
  } ]
}

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	Description	Required
orderId	Order ID	INTEGER	`ID of the order to close.`	true

Example JSON Structure

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

Output

Type: OBJECT

Properties

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

Output Example

{
  "id" : 1,
  "currency" : "",
  "note" : "",
  "email" : "",
  "name" : "",
  "phone" : "",
  "tags" : "",
  "line_items" : [ {
    "fulfillment_status" : "",
    "grams" : "",
    "price" : 0.0,
    "product_id" : 1,
    "variant_id" : 1,
    "quantity" : 1,
    "title" : ""
  } ]
}

Triggers

New Cancelled Order

Name: newCancelledOrder

Triggers when order is cancelled.

Type: DYNAMIC_WEBHOOK

Output

Type: OBJECT

Properties

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

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	Description
id	INTEGER
currency	STRING
note	STRING
email	STRING
name	STRING
phone	STRING
tags	STRING
line_items	ARRAY Items [{STRING(fulfillment_status), STRING(grams), NUMBER(price), INTEGER(product_id), INTEGER(variant_id), INTEGER(quantity), STRING(title)}]

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	Description
id	INTEGER
currency	STRING
note	STRING
email	STRING
name	STRING
phone	STRING
tags	STRING
line_items	ARRAY Items [{STRING(fulfillment_status), STRING(grams), NUMBER(price), INTEGER(product_id), INTEGER(variant_id), INTEGER(quantity), STRING(title)}]

JSON Example

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

Shopify

On this page