Skip to content

Shopify

Reference


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

Categories: [e-commerce]

Version: 1


Connections

Version: 1

API Key

Properties

NameTypeControl TypeDescription
Shop nameSTRINGTEXT
Access tokenSTRINGTEXT
Access TokenSTRINGTEXT

Triggers

New Cancelled Order

Triggers when order is cancelled.

Type: DYNAMIC_WEBHOOK

Properties

NameTypeControl TypeDescription
null

Output

Type: OBJECT

Properties

TypeControl Type
IdINTEGER
CurrencySTRING
NoteSTRING
EmailSTRING
NameSTRING
PhoneSTRING
TagsSTRING
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

NameTypeControl TypeDescription
null

Output

Type: OBJECT

Properties

TypeControl Type
IdINTEGER
CurrencySTRING
NoteSTRING
EmailSTRING
NameSTRING
PhoneSTRING
TagsSTRING
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

NameTypeControl TypeDescription
null

Output

Type: OBJECT

Properties

TypeControl Type
IdINTEGER
CurrencySTRING
NoteSTRING
EmailSTRING
NameSTRING
PhoneSTRING
TagsSTRING
Line Items[{STRING(fulfillment_status), STRING(grams), NUMBER(price), INTEGER(product_id), INTEGER(variant_id), INTEGER(quantity), STRING(title)}]

Actions

Create an order

Adds an order into a Shopify store.

Properties

NameTypeControl TypeDescription
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

Output

Type: OBJECT

Properties

TypeControl Type
IdINTEGER
CurrencySTRING
NoteSTRING
EmailSTRING
NameSTRING
PhoneSTRING
TagsSTRING
Line Items[{STRING(fulfillment_status), STRING(grams), NUMBER(price), INTEGER(product_id), INTEGER(variant_id), INTEGER(quantity), STRING(title)}]

Delete an order

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

Properties

NameTypeControl TypeDescription
Order IdINTEGERSELECTThe order id.

Cancel an order

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

Properties

NameTypeControl TypeDescription
Order IdINTEGERSELECTThe order id.

Output

Type: OBJECT

Properties

TypeControl Type
IdINTEGER
CurrencySTRING
NoteSTRING
EmailSTRING
NameSTRING
PhoneSTRING
TagsSTRING
Line Items[{STRING(fulfillment_status), STRING(grams), NUMBER(price), INTEGER(product_id), INTEGER(variant_id), INTEGER(quantity), STRING(title)}]

Update an order

Update an existing order.

Properties

NameTypeControl TypeDescription
Order IdINTEGERSELECTThe order id.
Order{{STRING(note), STRING(email), STRING(phone), STRING(tags)}(order)}OBJECT_BUILDER

Output

Type: OBJECT

Properties

TypeControl Type
IdINTEGER
CurrencySTRING
NoteSTRING
EmailSTRING
NameSTRING
PhoneSTRING
TagsSTRING
Line Items[{STRING(fulfillment_status), STRING(grams), NUMBER(price), INTEGER(product_id), INTEGER(variant_id), INTEGER(quantity), STRING(title)}]

Close an order

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

Properties

NameTypeControl TypeDescription
Order IdINTEGERSELECTThe order id.

Output

Type: OBJECT

Properties

TypeControl Type
IdINTEGER
CurrencySTRING
NoteSTRING
EmailSTRING
NameSTRING
PhoneSTRING
TagsSTRING
Line Items[{STRING(fulfillment_status), STRING(grams), NUMBER(price), INTEGER(product_id), INTEGER(variant_id), INTEGER(quantity), STRING(title)}]

Additional instructions


CONNECTION