Skip to main content

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

InputKeyNotesExample

Host

string
/ Required
hostProvide a string value for the domain of your shopify platform.www.shopify.com

OrderId

string
/ Required
orderIdProvide the unique identifier of the order0283002

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyDefaultNotesExample

Address 1

string
addressProvide a value for the street address4 privet drive

City

string
cityProvide a value for the citySan Jose

Country

string
countryProvide a value for the countryUnited States

Email

string
/ Required
emailProvide a string value for the email of the customersomeone@example.com

Values

string
fieldValuesThe 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
firstNameProvide a string value for the first nameJohn

Host

string
/ Required
hostProvide a string value for the domain of your shopify platform.www.shopify.com

Last Name

string
/ Required
lastNameProvide a string value for the last name of the customerDoe

Notes

string
notesProvide a value for a note on the customerThis is an example note.

Phone

string
phoneProvide a value for the phone number of the customer+18005555454

Province

string
provinceProvide a value for the provinceCalifornia

Verified Email

boolean
/ Required
verifiedEmailfalseThis flag will enable emails to be sent to the customer.

Zipcode

string
zipProvide a value for the zipcode45260

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyNotesExample

Customer Id

string
/ Required
customerIdProvide a value for the unique identifier of the customer028302

Financial Status

string
/ Required
financialStatusProvide a value for the financial status of the orderpending

Host

string
/ Required
hostProvide a string value for the domain of your shopify platform.www.shopify.com

Quantity

string
/ Required
quantityProvide a value for the quantity of the variant to be included on the order20

Variant Id

string
/ Required
variantIdProvide the unique identifier of the variant

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyNotesExample

Body HTML

string
bodyShopify 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
fieldValuesThe 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
hostProvide a string value for the domain of your shopify platform.www.shopify.com

Image URL

string
imageUrlProvide a valid url containing the image for the product.www.myimages.com/product1

Product Type

string
/ Required
productTypeProvide a value for the type of product.T-shirt

Tags

string
tagsFor each list item, provide a string you would like to tag the product with.Style

Title

string
/ Required
titleProvide a value for the title of the productClassic T-shirt

Vendor

string
/ Required
vendorProvide a value for the vendor of the product.Burton inc.

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyNotesExample

Values

string
fieldValuesThe 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
hostProvide a string value for the domain of your shopify platform.www.shopify.com

Price

string
/ Required
priceProvide the price of the variant.1.00

Product Id

string
/ Required
productIdProvide a value for the product Id74020090

SKU

string
skuProvide the sku(A stock-keeping unit) for the variant1.00

Variant Title

string
/ Required
variantTitleProvide the variant title in relation to the base product.Yellow

Weight

string
weightProvide the weight of the variant (lbs)24.00

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyNotesExample

Customer Id

string
/ Required
customerIdProvide a value for the unique identifier of the customer028302

Host

string
/ Required
hostProvide a string value for the domain of your shopify platform.www.shopify.com

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyNotesExample

Host

string
/ Required
hostProvide a string value for the domain of your shopify platform.www.shopify.com

OrderId

string
/ Required
orderIdProvide the unique identifier of the order0283002

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyNotesExample

Host

string
/ Required
hostProvide a string value for the domain of your shopify platform.www.shopify.com

Product Id

string
/ Required
productIdProvide a value for the product Id74020090

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyNotesExample

Host

string
/ Required
hostProvide a string value for the domain of your shopify platform.www.shopify.com

Product Id

string
/ Required
productIdProvide a value for the product Id74020090

Variant Id

string
/ Required
variantIdProvide the unique identifier of the variant

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyNotesExample

Customer Id

string
/ Required
customerIdProvide a value for the unique identifier of the customer028302

Host

string
/ Required
hostProvide a string value for the domain of your shopify platform.www.shopify.com

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyNotesExample

Host

string
/ Required
hostProvide a string value for the domain of your shopify platform.www.shopify.com

OrderId

string
/ Required
orderIdProvide the unique identifier of the order0283002

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyNotesExample

Host

string
/ Required
hostProvide a string value for the domain of your shopify platform.www.shopify.com

Product Id

string
/ Required
productIdProvide a value for the product Id74020090

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyNotesExample

Host

string
/ Required
hostProvide a string value for the domain of your shopify platform.www.shopify.com

Variant Id

string
/ Required
variantIdProvide the unique identifier of the variant

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyNotesExample

Host

string
/ Required
hostProvide a string value for the domain of your shopify platform.www.shopify.com

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyNotesExample

Host

string
/ Required
hostProvide a string value for the domain of your shopify platform.www.shopify.com

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyNotesExample

Host

string
/ Required
hostProvide a string value for the domain of your shopify platform.www.shopify.com

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyNotesExample

Host

string
/ Required
hostProvide a string value for the domain of your shopify platform.www.shopify.com

Product Id

string
/ Required
productIdProvide a value for the product Id74020090

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyDefaultNotesExample

Customer Id

string
/ Required
customerIdProvide a value for the unique identifier of the customer028302

Values

string
fieldValuesThe 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
hostProvide a string value for the domain of your shopify platform.www.shopify.com

Notes

string
notesProvide a value for a note on the customerThis is an example note.

Phone

string
phoneProvide a value for the phone number of the customer+18005555454

Email

string
updateEmailProvide a string value for the email of the customersomeone@example.com

First Name

string
updateFirstNameProvide a string value for the first nameJohn

Last Name

string
updateLastNameProvide a string value for the last name of the customerDoe

Verified Email

boolean
/ Required
verifiedEmailfalseThis flag will enable emails to be sent to the customer.

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyNotesExample

Values

string
fieldValuesThe 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
hostProvide a string value for the domain of your shopify platform.www.shopify.com

Image URL

string
imageUrlProvide a valid url containing the image for the product.www.myimages.com/product1

Product Id

string
/ Required
productIdProvide a value for the product Id74020090

Product Status

string
productStatusSpecify if the product is active or in draft.

Tags

string
tagsFor each list item, provide a string you would like to tag the product with.Style

Title

string
/ Required
titleProvide a value for the title of the productClassic T-shirt

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyNotesExample

Values

string
fieldValuesThe 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
hostProvide a string value for the domain of your shopify platform.www.shopify.com

SKU

string
skuProvide the sku(A stock-keeping unit) for the variant1.00

Price

string
updatePriceProvide the price of the variant.1.00

Variant Title

string
updateVariantTitleProvide the variant title in relation to the base product.Yellow

Variant Id

string
/ Required
variantIdProvide the unique identifier of the variant

Weight

string
weightProvide the weight of the variant (lbs)24.00

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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