Shopify
Shopify is an e-commerce platform for online stores and retail point-of-sale systems.
Triggers
Trigger |
Configuration fields |
Data type |
Required? |
---|---|---|---|
Customer created - A customer was created |
|
|
|
Customer updated - A customer was updated |
|
|
|
Product created - A product was created |
|
|
|
Product updated - A product was updated |
|
|
|
Order created - An order was created |
|
|
|
Order updated - An order was updated |
|
|
|
Actions
Action |
Configuration fields |
Data type |
Required? |
---|---|---|---|
Create order - Creates an order |
Line items - A list of line item objects, each containing information about an item in the order. Each object has the following properties: |
|
|
Address - An optional additional field for the street address of the billing address |
String |
|
|
Address - An optional additional field for the street address of the shipping address |
String |
|
|
Note - An optional note that a shop owner can attach to the order |
String |
|
|
Financial status - Choose the status of payments associated with the order. Can only be set when the order is created. |
Choice |
|
|
Currency - Choose the three-letter code (ISO 4217 format) for the shop currency, and remove trailing period. USD |
Choice |
|
|
Discount type - Choose the type of discount |
Choice |
|
|
Tags - Tags attached to the order, formatted as a string of comma-separated values |
String |
|
|
Discount amount - The amount that`s deducted from the order total |
String |
|
|
Inventory behaviour - The behaviour to use when updating inventory. (default: bypass) |
Choice |
|
|
City - The city, town, or village of the billing address |
String |
|
|
City - The city, town, or village of the shipping address |
String |
|
|
Email - The customer`s email address foo@example.com |
String |
|
|
First name - The first name of the person associated with the billing address |
String |
|
|
First name - The first name of the person associated with the shipping address |
String |
|
|
Last name - The last name of the person associated with the billing address |
String |
|
|
Last name - The last name of the person associated with the shipping address |
String |
|
|
Company - The name of the country of the billing address |
String |
|
|
Country - The name of the country of the billing address |
String |
|
|
Company - The name of the country of the shipping address |
String |
|
|
Country - The name of the country of the shipping address |
String |
|
|
State/Province/Region - The name of the region (for example, province, state, or prefecture) of the billing address |
String |
|
|
State/Province/Region - The name of the region (for example, province, state, or prefecture) of the shipping address |
String |
|
|
Fulfillment status - The order`s status in terms of fulfilled line items |
Choice |
|
|
Phone - The phone number at the billing address |
String |
|
|
Phone - The phone number at the shipping address |
String |
|
|
Postal/Zip code - The postal code (for example, zip, postcode, or Eircode) of the billing address |
String |
|
|
Postal/Zip code - The postal code (for example, zip, postcode, or Eircode) of the shipping address |
String |
|
|
Source name - The source of the checkout. To use this field for sales attribution, you must register the channels that your app is managing. |
String |
|
|
Address - The street address of the billing address |
String |
|
|
Address - The street address of the shipping address |
String |
|
|
Discount - Code - When the associated discount application is of type code, this property returns the discount code that was entered at checkout. |
String |
|
|
Send fulfillment receipt - Whether to send a shipping confirmation to the customer. (default: `false`) |
Boolean |
|
|
Send receipt - Whether to send an order confirmation to the customer. (default: `false`) |
Boolean |
|
|
Update order - Updates an order |
Order number - Unique ID for a given order Example: 450789469 |
String |
|
Address - An optional additional field for the street address of the shipping address |
String |
|
|
Note - An optional note that a shop owner can attach to the order |
String |
|
|
Tags - Tags attached to the order, formatted as a string of comma-separated values |
String |
|
|
City - The city, town, or village of the shipping address |
String |
|
|
Email - The customer`s email address foo@example.com |
String |
|
|
Phone - The customer`s phone number for receiving SMS notifications |
String |
|
|
First name - The first name of the person associated with the shipping address |
String |
|
|
Order ID - The ID of the order, used for API purposes. This is different from the Order number property, which is the ID used by the shop owner and customer. Example: 450789469 |
String |
|
|
Last name - The last name of the person associated with the shipping address |
String |
|
|
Company - The name of the country of the shipping address |
String |
|
|
Country - The name of the country of the shipping address |
String |
|
|
State/Province/Region - The name of the region (for example, province, state, or prefecture) of the shipping address |
String |
|
|
Phone - The phone number at the shipping address |
String |
|
|
Postal/Zip code - The postal code (for example, zip, postcode, or Eircode) of the shipping address |
String |
|
|
Address - The street address of the shipping address |
String |
|
|
Buyer accepts marketing - Whether the customer consented to receive email updates from the shop |
Boolean |
|
|
Cancel order - Cancels an order |
Order number - Unique ID for a given order Example: 450789469 |
String |
|
Currency - Choose the three-letter code (ISO 4217 format) for the shop currency, and remove trailing period. USD |
Choice |
|
|
Amount - The amount to refund |
String |
|
|
Email - The customer`s email address Example: foo@example.com |
String |
|
|
Custom action - Creates a custom action |
Path - Enter the path of the endpoint |
String |
|
Query string - Enter a parameter and a value. The string will be URL-encoded and appended to the URL. |
|
|
|
Create customer - Add a new customer |
Notes - Enter additional information about the customer Example: Must confirm the delivery address |
String |
|
Tags - Enter comma-separated tags to categorize customers into groups Example: credit_card, wholesale |
String |
|
|
Address - Enter the address of the customer Example: 123 Main Street |
String |
|
|
City - Enter the city of the address Example: Anytown |
String |
|
|
Email address - Enter the customer's email address Example: jessedoe@example.com |
String |
|
|
First name - Enter the customer's first name Example: Jesse |
String |
|
|
Last name - Enter the customer's last name Example: Doe |
String |
|
|
Phone number - Enter the customer's phone number Example: +15142546011 |
String |
|
|
First name - Enter the first name of the customer at the address Example: Jesse |
String |
|
|
Last name - Enter the last name of the customer at the address Example: Doe |
String |
|
|
Company - Enter the name of the company at the address Example: ABC Company, Inc. |
String |
|
|
Zip code - Enter the zip code of the address Example: 95051 |
String |
|
|
Accepts marketing - Indicate whether the customer accepts marketing |
Boolean |
|
|
Tax exempt status - Indicate whether the customer is exempt from taxes |
Boolean |
|
|
Update customer - Update an existing customer record |
Customer ID - Enter the customer's unique identifier Example: 207119551 |
String |
|
Notes - Enter additional information about the customer Example: Must confirm the delivery address |
String |
|
|
Tags - Enter comma-separated tags to categorize customers into groups Example: credit_card, wholesale |
String |
|
|
Address - Enter the address of the customer Example: 123 Main Street |
String |
|
|
City - Enter the city of the address Example: Anytown |
String |
|
|
Email address - Enter the customer's email address Example: johndoe@example.com |
String |
|
|
First name - Enter the customer's first name Example: Jesse |
String |
|
|
Last name - Enter the customer's last name Example: Doe |
String |
|
|
Phone number - Enter the customer's phone number Example: +15142546011 |
String |
|
|
First name - Enter the first name of the customer at the address Example: Jesse |
String |
|
|
Last name - Enter the last name of the customer at the address Example: Doe |
String |
|
|
Company - Enter the name of the company at the address Example: Organization Inc |
String |
|
|
Zip code - Enter the zip code of the address Example: 95051 |
String |
|
|
Accepts marketing - Indicate whether the customer accepts marketing |
Boolean |
|
|
Tax exempt status - Indicate whether the customer is exempt from taxes |
Boolean |
|
|
Update a product - Update the information about a product |
Product ID - Enter the identifier of the product to update Example: 123131312 |
String |
|
Description HTML - Enter an HTML description of the product Example: <strong>Good snowboard!</strong> |
String |
|
|
Tags - Enter comma-separated tags to categorize the product Example: snow, snowboard |
String |
|
|
Title - Enter the product title Example: Burton Custom Freestyle 151 |
String |
|
|
Vendor - Enter the vendor of the product Example: Burton |
String |
|
|
Product variants - Specify the product's variants |
|
|
|
Image - The product's image Example: https://example.com/image.png |
|
|
|
Product type - The product type Example: Snowboard |
String |
|
|
Create product - Add a new product with a default product variant |
Description HTML - Enter an HTML description of the product Example: <strong>Good snowboard!</strong> |
String |
|
Tags - Enter comma-separated tags to categorize the product Example: snow, snowboard |
String |
|
|
Product type - Enter the product type Example: Snowboard |
String |
|
|
Product title - Enter the title of the product Example: Burton Custom Freestyle 151 |
String |
|
|
Vendor - Enter the vendor of the product Example: Burton |
String |
|
|
Image - Select the product's image Example: https://example.com/image.png |
|
|
|
Product variants - Specify the product's variants |
|
|
|
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. |
Order ID - Unique ID for a given order Example: 450789469 |
String |
|
Delete an order - Deletes an order. Orders that interact with an online gateway can`t be deleted. |
Order ID - Unique ID for a given order Example: 450789469 |
String |
|
Re-open a closed order - Re-opens a closed order |
Order ID - Unique ID for a given order Example: 450789469 |
String |
|
Get list of transactions from an order - Retrieve a list of transactions from an order |
Fields - A comma-separated list of field names to be shown |
String |
|
Since ID - Retrieve only transactions that occurred after the specified transaction ID Example: 801038806 |
String |
|
|
In-shop currency - Show amounts in the shop currency |
Boolean |
|
|
Order ID - Unique ID for a given order Example: 450789469 |
String |
|
|
Retrieve a list of orders - Retrieves a list of orders that meet the specified criteria |
Status - Choose the status of the orders to return |
Choice |
|
Retrieve a specific order - Retrieves an order by specifying the ID. All fields of an order are returned unless specific fields are named. Returns open orders by default. |
Fields - A comma-separated list of field names to be shown |
String |
|
Order ID - Unique ID for a given order Example: 450789469 |
String |
|
|
Retrieve an order count - Retrieves the total number of orders that meet the specified criteria |
Status - Choose the status of orders to return |
Choice |
|
Find product by ID - Return a product by searching for its ID |
Product ID - Enter the ID of the product to find Example: 12345678 |
String |
|
Find product by title - Return a product by searching for its title |
Product title - Enter the title of the product to search for Example: Burton Custom Freestyle 151 |
String |
|