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 | {{[{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 | Id | INTEGER |
currency | Currency | STRING |
note | Note | STRING |
STRING | ||
name | Name | STRING |
phone | Phone | STRING |
tags | Tags | STRING |
line_items | Line Items | [{STRING(fulfillment_status), STRING(grams), NUMBER(price), INTEGER(product_id), INTEGER(variant_id), INTEGER(quantity), STRING(title)}] |
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 |
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 | Id | INTEGER |
currency | Currency | STRING |
note | Note | STRING |
STRING | ||
name | Name | STRING |
phone | Phone | STRING |
tags | Tags | STRING |
line_items | Line Items | [{STRING(fulfillment_status), STRING(grams), NUMBER(price), INTEGER(product_id), INTEGER(variant_id), INTEGER(quantity), STRING(title)}] |
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 | {{STRING(note), STRING(email), STRING(phone), STRING(tags)}(order)} | OBJECT_BUILDER | null |
Output
Type: OBJECT
Properties
Name | Type | Control Type |
---|---|---|
id | Id | INTEGER |
currency | Currency | STRING |
note | Note | STRING |
STRING | ||
name | Name | STRING |
phone | Phone | STRING |
tags | Tags | STRING |
line_items | Line Items | [{STRING(fulfillment_status), STRING(grams), NUMBER(price), INTEGER(product_id), INTEGER(variant_id), INTEGER(quantity), STRING(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 | 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 | Id | INTEGER |
currency | Currency | STRING |
note | Note | STRING |
STRING | ||
name | Name | STRING |
phone | Phone | STRING |
tags | Tags | STRING |
line_items | Line Items | [{STRING(fulfillment_status), STRING(grams), NUMBER(price), INTEGER(product_id), INTEGER(variant_id), INTEGER(quantity), STRING(title)}] |
Triggers
New Cancelled Order
Triggers when order is cancelled.
Type: DYNAMIC_WEBHOOK
Properties
Name | Label | Type | Control Type | Description | Required |
---|---|---|---|---|---|
null |
Output
Type: OBJECT
Properties
Name | Type | Control Type |
---|---|---|
id | Id | INTEGER |
currency | Currency | STRING |
note | Note | STRING |
STRING | ||
name | Name | STRING |
phone | Phone | STRING |
tags | Tags | STRING |
line_items | Line Items | [{STRING(fulfillment_status), STRING(grams), NUMBER(price), INTEGER(product_id), INTEGER(variant_id), INTEGER(quantity), STRING(title)}] |
New Order
Triggers when new order is created.
Type: DYNAMIC_WEBHOOK
Properties
Name | Label | Type | Control Type | Description | Required |
---|---|---|---|---|---|
null |
Output
Type: OBJECT
Properties
Name | Type | Control Type |
---|---|---|
id | Id | INTEGER |
currency | Currency | STRING |
note | Note | STRING |
STRING | ||
name | Name | STRING |
phone | Phone | STRING |
tags | Tags | STRING |
line_items | Line Items | [{STRING(fulfillment_status), STRING(grams), NUMBER(price), INTEGER(product_id), INTEGER(variant_id), INTEGER(quantity), STRING(title)}] |
New Paid Order
Triggers when paid order is created.
Type: DYNAMIC_WEBHOOK
Properties
Name | Label | Type | Control Type | Description | Required |
---|---|---|---|---|---|
null |
Output
Type: OBJECT
Properties
Name | Type | Control Type |
---|---|---|
id | Id | INTEGER |
currency | Currency | STRING |
note | Note | STRING |
STRING | ||
name | Name | STRING |
phone | Phone | STRING |
tags | Tags | STRING |
line_items | Line Items | [{STRING(fulfillment_status), STRING(grams), NUMBER(price), INTEGER(product_id), INTEGER(variant_id), INTEGER(quantity), STRING(title)}] |