Shopify Component

Manage customers, products, and orders in your Shopify platform

Component key: shopify

Description

Shopify is a multinational e-commerce company. They offer a subscription-based software that allows anyone to set up an online store and sell their products. This component allows you to manage the products and customers connected to your Shopify account.

Authorization Notes

The Shopify component authenticates requests through a OAuth 2.0 credential. Information on how to generate an OAuth 2.0 credential with Shopify can be found here Now, you will have to configure OAuth 2.0 settings in Prismatic. Create a new credential of type OAuth 2.0 - Authorization Code.

• For Client ID and Client Secret enter the API Key and API Secret that you got from the Shopify developer dashboard.
• For Scopes choose from the list found on the Shopify docs
• For Authorization URL enter https://{YOUR SHOPIFY DOMAIN}.myshopify.com/admin/oauth/authorize
• For Access Token URL enter https://{YOUR SHOPIFY DOMAIN}.myshopify.com/admin/oauth/access_token, replacing {YOUR SHOPIFY DOMAIN} with your Shopify domain's name.

Actions

Cancel Order

Cancel an existing order | key: cancelOrder

Input	Key	Notes	Example
Host string / Required	host	Provide a string value for the domain of your shopify platform.	www.shopify.com
OrderId string / Required	orderId	Provide the unique identifier of the order	0283002

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---

Create Customer

Create a new customer | key: createCustomer

Input	Key	Default	Notes	Example
Address 1 string	address		Provide a value for the street address	4 privet drive
City string	city		Provide a value for the city	San Jose
Country string	country		Provide a value for the country	United States
Email string / Required	email		Provide a string value for the email of the customer	someone@example.com
Values string	fieldValues		The names of the fields and their values to use when creating/updating a record. You can use this input to specify the key and value of any property that is not already in Prismatic.
First Name string / Required	firstName		Provide a string value for the first name	John
Host string / Required	host		Provide a string value for the domain of your shopify platform.	www.shopify.com
Last Name string / Required	lastName		Provide a string value for the last name of the customer	Doe
Notes string	notes		Provide a value for a note on the customer	This is an example note.
Phone string	phone		Provide a value for the phone number of the customer	+18005555454
Province string	province		Provide a value for the province	California
Verified Email boolean / Required	verifiedEmail	false	This flag will enable emails to be sent to the customer.
Zipcode string	zip		Provide a value for the zipcode	45260

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---

Create Order

Create a new order | key: createOrder

Input	Key	Notes	Example
Customer Id string / Required	customerId	Provide a value for the unique identifier of the customer	028302
Financial Status string / Required	financialStatus	Provide a value for the financial status of the order	pending
Host string / Required	host	Provide a string value for the domain of your shopify platform.	www.shopify.com
Quantity string / Required	quantity	Provide a value for the quantity of the variant to be included on the order	20
Variant Id string / Required	variantId	Provide the unique identifier of the variant

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---

Create Product

Create a new product | key: createProduct

Input	Key	Notes	Example
Body HTML string	body	Shopify gives you the option to specify a body formatted in html to be displayed along the rest of the product information.	<strong>Try our classic fit!</strong>
Values string	fieldValues	The names of the fields and their values to use when creating/updating a record. You can use this input to specify the key and value of any property that is not already in Prismatic.
Host string / Required	host	Provide a string value for the domain of your shopify platform.	www.shopify.com
Image URL string	imageUrl	Provide a valid url containing the image for the product.	www.myimages.com/product1
Product Type string / Required	productType	Provide a value for the type of product.	T-shirt
Tags string	tags	For each list item, provide a string you would like to tag the product with.	Style
Title string / Required	title	Provide a value for the title of the product	Classic T-shirt
Vendor string / Required	vendor	Provide a value for the vendor of the product.	Burton inc.

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---

Create Variant

Create a new variant of the provided product | key: createVariant

Input	Key	Notes	Example
Values string	fieldValues	The names of the fields and their values to use when creating/updating a record. You can use this input to specify the key and value of any property that is not already in Prismatic.
Host string / Required	host	Provide a string value for the domain of your shopify platform.	www.shopify.com
Price string / Required	price	Provide the price of the variant.	1.00
Product Id string / Required	productId	Provide a value for the product Id	74020090
SKU string	sku	Provide the sku(A stock-keeping unit) for the variant	1.00
Variant Title string / Required	variantTitle	Provide the variant title in relation to the base product.	Yellow
Weight string	weight	Provide the weight of the variant (lbs)	24.00

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---

Delete Customer

Delete an existing customer | key: deleteCustomer

Input	Key	Notes	Example
Customer Id string / Required	customerId	Provide a value for the unique identifier of the customer	028302
Host string / Required	host	Provide a string value for the domain of your shopify platform.	www.shopify.com

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---

Delete Order

Delete an existing order by Id | key: deleteOrder

Input	Key	Notes	Example
Host string / Required	host	Provide a string value for the domain of your shopify platform.	www.shopify.com
OrderId string / Required	orderId	Provide the unique identifier of the order	0283002

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---

Delete Product

Delete an existing product | key: deleteProduct

Input	Key	Notes	Example
Host string / Required	host	Provide a string value for the domain of your shopify platform.	www.shopify.com
Product Id string / Required	productId	Provide a value for the product Id	74020090

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---

Delete Variant

Delete an existing variant by Id | key: deleteVariant

Input	Key	Notes	Example
Host string / Required	host	Provide a string value for the domain of your shopify platform.	www.shopify.com
Product Id string / Required	productId	Provide a value for the product Id	74020090
Variant Id string / Required	variantId	Provide the unique identifier of the variant

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---

Get Customer

Get a customers information and metadata by Id | key: getCustomer

Input	Key	Notes	Example
Customer Id string / Required	customerId	Provide a value for the unique identifier of the customer	028302
Host string / Required	host	Provide a string value for the domain of your shopify platform.	www.shopify.com

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---

Get Order

Get the information and metadata about an order | key: getOrder

Input	Key	Notes	Example
Host string / Required	host	Provide a string value for the domain of your shopify platform.	www.shopify.com
OrderId string / Required	orderId	Provide the unique identifier of the order	0283002

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---

Get Product

Get the information and metadata of a product by Id | key: getProduct

Input	Key	Notes	Example
Host string / Required	host	Provide a string value for the domain of your shopify platform.	www.shopify.com
Product Id string / Required	productId	Provide a value for the product Id	74020090

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---

Get Variant

Get the information or metadata of a variant by Id | key: getVariant

Input	Key	Notes	Example
Host string / Required	host	Provide a string value for the domain of your shopify platform.	www.shopify.com
Variant Id string / Required	variantId	Provide the unique identifier of the variant

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---

List Customers

List all customers connected to your platform | key: listCustomers

Input	Key	Notes	Example
Host string / Required	host	Provide a string value for the domain of your shopify platform.	www.shopify.com

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---

List Orders

List all orders | key: listOrders

Input	Key	Notes	Example
Host string / Required	host	Provide a string value for the domain of your shopify platform.	www.shopify.com

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---

List Products

List all products connected to your platform | key: listProducts

Input	Key	Notes	Example
Host string / Required	host	Provide a string value for the domain of your shopify platform.	www.shopify.com

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---

List Variants

List all variants connected to the provided product | key: listVariants

Input	Key	Notes	Example
Host string / Required	host	Provide a string value for the domain of your shopify platform.	www.shopify.com
Product Id string / Required	productId	Provide a value for the product Id	74020090

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---

Update Customer

Update the information and metadata of an existing customer by Id | key: updateCustomer

Input	Key	Default	Notes	Example
Customer Id string / Required	customerId		Provide a value for the unique identifier of the customer	028302
Values string	fieldValues		The names of the fields and their values to use when creating/updating a record. You can use this input to specify the key and value of any property that is not already in Prismatic.
Host string / Required	host		Provide a string value for the domain of your shopify platform.	www.shopify.com
Notes string	notes		Provide a value for a note on the customer	This is an example note.
Phone string	phone		Provide a value for the phone number of the customer	+18005555454
Email string	updateEmail		Provide a string value for the email of the customer	someone@example.com
First Name string	updateFirstName		Provide a string value for the first name	John
Last Name string	updateLastName		Provide a string value for the last name of the customer	Doe
Verified Email boolean / Required	verifiedEmail	false	This flag will enable emails to be sent to the customer.

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---

Update Product

Update the information and metadata of an existing product by Id | key: updateProduct

Input	Key	Notes	Example
Values string	fieldValues	The names of the fields and their values to use when creating/updating a record. You can use this input to specify the key and value of any property that is not already in Prismatic.
Host string / Required	host	Provide a string value for the domain of your shopify platform.	www.shopify.com
Image URL string	imageUrl	Provide a valid url containing the image for the product.	www.myimages.com/product1
Product Id string / Required	productId	Provide a value for the product Id	74020090
Product Status string	productStatus	Specify if the product is active or in draft.
Tags string	tags	For each list item, provide a string you would like to tag the product with.	Style
Title string / Required	title	Provide a value for the title of the product	Classic T-shirt

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---

Update Variant

Update the information and metadata of an existing product variant by Id | key: updateVariant

Input	Key	Notes	Example
Values string	fieldValues	The names of the fields and their values to use when creating/updating a record. You can use this input to specify the key and value of any property that is not already in Prismatic.
Host string / Required	host	Provide a string value for the domain of your shopify platform.	www.shopify.com
SKU string	sku	Provide the sku(A stock-keeping unit) for the variant	1.00
Price string	updatePrice	Provide the price of the variant.	1.00
Variant Title string	updateVariantTitle	Provide the variant title in relation to the base product.	Yellow
Variant Id string / Required	variantId	Provide the unique identifier of the variant
Weight string	weight	Provide the weight of the variant (lbs)	24.00

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---