Shopify
Shopify is an e-commerce platform that allows businesses to create online stores and sell products.
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 | Description | 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
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
id | INTEGER | |
currency | STRING | |
note | STRING | |
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
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
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
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
id | INTEGER | |
currency | STRING | |
note | STRING | |
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
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
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
id | INTEGER | |
currency | STRING | |
note | STRING | |
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
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
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
id | INTEGER | |
currency | STRING | |
note | STRING | |
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
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 | |
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
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 | |
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
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 | |
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)}] |