Skip to content

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

NameLabelTypeControl TypeDescriptionRequired
shopNameShop nameSTRINGTEXTtrue
keyAccess tokenSTRINGTEXTtrue
valueAccess TokenSTRINGTEXTtrue

Actions

Create Order

Name: createOrder

Adds an order into a Shopify store.

Properties

NameLabelTypeControl TypeDescriptionRequired
__itemOrder{{[{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_BUILDERnull

Output

Type: OBJECT

Properties

NameTypeControl Type
idIdINTEGER
currencyCurrencySTRING
noteNoteSTRING
emailEmailSTRING
nameNameSTRING
phonePhoneSTRING
tagsTagsSTRING
line_itemsLine 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

NameLabelTypeControl TypeDescriptionRequired
orderIdOrder IDINTEGERSELECTID 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

NameLabelTypeControl TypeDescriptionRequired
orderIdOrder IDINTEGERSELECTID of the order to cancel.true

Output

Type: OBJECT

Properties

NameTypeControl Type
idIdINTEGER
currencyCurrencySTRING
noteNoteSTRING
emailEmailSTRING
nameNameSTRING
phonePhoneSTRING
tagsTagsSTRING
line_itemsLine 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

NameLabelTypeControl TypeDescriptionRequired
orderIdOrder IDINTEGERSELECTID of the order to update.true
__itemOrder{{STRING(note), STRING(email), STRING(phone), STRING(tags)}(order)}OBJECT_BUILDERnull

Output

Type: OBJECT

Properties

NameTypeControl Type
idIdINTEGER
currencyCurrencySTRING
noteNoteSTRING
emailEmailSTRING
nameNameSTRING
phonePhoneSTRING
tagsTagsSTRING
line_itemsLine 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

NameLabelTypeControl TypeDescriptionRequired
orderIdOrder IDINTEGERSELECTID of the order to close.true

Output

Type: OBJECT

Properties

NameTypeControl Type
idIdINTEGER
currencyCurrencySTRING
noteNoteSTRING
emailEmailSTRING
nameNameSTRING
phonePhoneSTRING
tagsTagsSTRING
line_itemsLine 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

NameLabelTypeControl TypeDescriptionRequired
null

Output

Type: OBJECT

Properties

NameTypeControl Type
idIdINTEGER
currencyCurrencySTRING
noteNoteSTRING
emailEmailSTRING
nameNameSTRING
phonePhoneSTRING
tagsTagsSTRING
line_itemsLine 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

NameLabelTypeControl TypeDescriptionRequired
null

Output

Type: OBJECT

Properties

NameTypeControl Type
idIdINTEGER
currencyCurrencySTRING
noteNoteSTRING
emailEmailSTRING
nameNameSTRING
phonePhoneSTRING
tagsTagsSTRING
line_itemsLine 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

NameLabelTypeControl TypeDescriptionRequired
null

Output

Type: OBJECT

Properties

NameTypeControl Type
idIdINTEGER
currencyCurrencySTRING
noteNoteSTRING
emailEmailSTRING
nameNameSTRING
phonePhoneSTRING
tagsTagsSTRING
line_itemsLine Items[{STRING(fulfillment_status), STRING(grams), NUMBER(price), INTEGER(product_id), INTEGER(variant_id), INTEGER(quantity), STRING(title)}]


Additional instructions


CONNECTION