Shopify Component

Manage customers, products, and orders in your Shopify platform
Component key: shopify#
DescriptionShopify 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.
#
Shopify Connections#
Admin API Access TokenAn admin API access token can be used for testing purposes as you develop your integration. You can create an access token from the API credentials tab of a private Shopify app that you create.
Before publishing an integration for customers, we recommend you switch to OAuth 2.0 authentication to give your users a single button-click experience.
Input | Default | Notes | Example |
---|---|---|---|
Input Admin API Access Token password / Required adminApiAccessToken | Default | Notes Generate from the 'API credentials' tab of a private Shopify app that you own | Example shpat_00000000000000000000000000000000 |
Input Host string / Required host | Default YOUR-SHOPIFY-DOMAIN.myshopify.com | Notes The domain of your Shopify platform, without the https:// | Example YOUR-SHOPIFY-DOMAIN.myshopify.com |
#
Shopify OAuth 2.0The Shopify component authenticates requests through a OAuth 2.0 credential. Information on how to generate an OAuth 2.0 app with Shopify can be found in their documentation
Now, you will have to configure OAuth 2.0 settings in Prismatic. Create a new Shopify connection of type OAuth 2.0.
- 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 documentation
Input | Default | Notes | Example |
---|---|---|---|
Input Authorize URL string / Required authorizeUrl | Default https://YOUR-SHOPIFY-DOMAIN.myshopify.com/admin/oauth/authorize | Notes The OAuth 2.0 Authorization URL for Shopify | Example |
Input API Key string / Required clientId | Default | Notes Obtain this by creating an app at https://partners.shopify.com/ | Example |
Input API Secret password / Required clientSecret | Default | Notes Obtain this by creating an app at https://partners.shopify.com/ | Example |
Input Host string / Required host | Default YOUR-SHOPIFY-DOMAIN.myshopify.com | Notes The domain of your Shopify platform, without the https:// | Example YOUR-SHOPIFY-DOMAIN.myshopify.com |
Input Scopes string scopes | Default write_orders read_customers | Notes A space-delimited set of one or more scopes to get the user's permission to access. A list of all scopes is available at https://shopify.dev/api/usage/access-scopes#authenticated-access-scopes | Example |
Input Token URL string / Required tokenUrl | Default https://YOUR-SHOPIFY-DOMAIN.myshopify.com/admin/oauth/access_token | Notes The OAuth 2.0 Token URL for Shopify | Example |
#
Triggers#
WebhookTrigger for handling webhook requests from the Shopify platform | key: webhook
You can configure a Shopify webhook to send information to a Prismatic webhook URL under certain conditions (a "Customer" is created, a "Order" is shipped, etc.).
A full list of configurable operations is available on the Shopify Docs
#
Output Example Payload{ "payload": { "headers": { "accept": "*/*", "Content-Type": "application/json", "User-Agent": "Shopify-Captain-Hook", "X-Shopify-Api-Version": "unstable", "X-Shopify-Shop-Domain": "example.myshopify.com", "X-Shopify-Topic": "customers/create", "X-Shopify-Webhook-Id": "example-webhook-id", "Host": "hooks.example.prismatic.io" }, "body": { "data": {} }, "rawBody": { "data": { "type": "Buffer", "data": [69, 120, 97, 109, 112, 108, 101] } }, "queryParameters": None, "webhookUrls": { "Flow 1": "https://hooks.example.prismatic.io/trigger/EXAMPLEGbG93Q29uZmlnOmRlNmNmNDMyLTliNWMtN0005NDMxLTRmYzA4ZjViODgxOA==" }, "webhookApiKeys": { "Flow 1": ["abc-123"] }, "customer": { "externalId": "customer-example-external-id", "name": "John Doe" } }}
#
Actions#
Cancel OrderCancel an existing order | key: cancelOrder
Input | Notes | Example |
---|---|---|
Input Order string / Required orderId | Notes Provide the unique identifier of the order. This value can either be an Id, orderNumber, orderName, or customer email. | Example #3002 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Close OrderCloses a completed order | key: closeOrder
Input | Notes | Example |
---|---|---|
Input Order string / Required orderId | Notes Provide the unique identifier of the order. This value can either be an Id, orderNumber, orderName, or customer email. | Example #3002 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Connect Inventory Item To LocationConnect an existing Inventory Item to an existing Location | key: connectInventoryLevel
Input | Notes | Example |
---|---|---|
Input Inventory Item Id string / Required itemId | Notes Provide a unique identifier of a Inventory Item | Example r84963704502935 |
Input Location string / Required locationId | Notes Provide a unique identifier of a location. This value can either be an Id, city, zip, location name, or province. | Example r84963704502935 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Count CollectsCount all available collects | key: countCollects
Input | Notes | Example |
---|---|---|
Input Collect Id string / Required collectId | Notes Provide a unique identifier of a collect | Example r84963704502935 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Count CustomersRetrieve a count of all the customers connected to your platform | key: countCustomers
Input | Notes |
---|---|
Input Connection connection / Required shopifyConnection | Notes |
#
Count Draft OrdersCount all draft orders | key: countDraftOrders
Input | Notes |
---|---|
Input Connection connection / Required shopifyConnection | Notes |
#
Count LocationCount the number of locations enabled on your platform | key: countLocations
Input | Notes |
---|---|
Input Connection connection / Required shopifyConnection | Notes |
#
Count OrdersReturns a count of all orders | key: countOrders
Input | Notes |
---|---|
Input Connection connection / Required shopifyConnection | Notes |
Input Status string / Required status | Notes Provide a status for the orders you want to be returned |
#
Count Product ImagesCount all product images connected to your platform | key: countProductImages
Input | Notes | Example |
---|---|---|
Input Product string / Required productId | Notes Provide a value for the product Id. This value can either be an Id or a product title. | Example 74020090 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Count ProductsCount all Products in your account | key: countProducts
Input | Notes | Example |
---|---|---|
Input Limit string limit | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
Input Page Info string pageInfo | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Count VariantsCount all product variants | key: countVariants
Input | Notes | Example |
---|---|---|
Input Product string / Required productId | Notes Provide a value for the product Id. This value can either be an Id or a product title. | Example 74020090 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Create Account Activation URLCreate an account activation URL for an existing customer | key: createAccountActivationURL
Input | Notes | Example |
---|---|---|
Input Customer string / Required customerId | Notes Provide a value for the unique identifier of the customer. This value can either be an Id, email, or phone number. | Example 028302 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Create CustomerCreate a new customer | key: createCustomer
Input | Default | Notes | Example |
---|---|---|---|
Input Address List code / Required addressList | Default | Notes Provide a JSON array containing address objects | Example
|
Input Currency Format string currency | Default | Notes Provide a valid currency format | Example USD |
Input Email string / Required email | Default | Notes Provide a string value for the email of the customer | Example someone@example.com |
Input Values string Key Value List fieldValues | Default | Notes 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. | Example |
Input First Name string / Required firstName | Default | Notes Provide a string value for the first name | Example John |
Input Last Name string / Required lastName | Default | Notes Provide a string value for the last name of the customer | Example Doe |
Input Metafields code metafields | Default | Notes Provide a JSON array containing metadata objects | Example
|
Input Notes string notes | Default | Notes Provide a value for a note on the customer | Example This is an example note. |
Input Phone string phone | Default | Notes Provide a value for the phone number of the customer | Example +18005555454 |
Input Connection connection / Required shopifyConnection | Default | Notes | Example |
Input Tags string Value List tags | Default | Notes For each list item, provide a string you would like to tag the product with. | Example Style |
Input Tax Exempt boolean taxExempt | Default false | Notes Determines if the customer is tax exempt. | Example |
Input Verified Email boolean / Required verifiedEmail | Default false | Notes This flag will enable emails to be sent to the customer. | Example |
#
Create Draft OrdersCreate a new draft order | key: createDraftOrder
Input | Default | Notes | Example |
---|---|---|---|
Input Customer string / Required customerId | Default | Notes Provide a value for the unique identifier of the customer. This value can either be an Id, email, or phone number. | Example 028302 |
Input Line items code / Required lineItems | Default | Notes Provide a JSON array containing objects(line items). For more information on building line item objects, refer to the Shopify docs: https://shopify.dev/api/admin-rest/2021-10/resources/draftorder#post-draft-orders | Example
|
Input Connection connection / Required shopifyConnection | Default | Notes | Example |
Input Subtotal Price string subTotalPrice | Default | Notes The subtotal price of the order. | Example 398 |
Input Taxes Included boolean / Required taxIncluded | Default false | Notes This flag determines if tax is included in the total order price. | Example |
Input Total Price string totalPrice | Default | Notes The total price of the order. | Example 11.94 |
Input Total Tax string totalTax | Default | Notes The total tax of the order. | Example 1.94 |
Input Use Customer Address boolean / Required useCustomerAddress | Default true | Notes This flag determines if the order will use the customers default address. | Example |
#
Create MetafieldCreate a new metafield in your platform | key: createMetafield
Input | Notes | Example |
---|---|---|
Input Description string description | Notes Provide a description of the metafield value. | Example string |
Input Key string / Required key | Notes Provide a key for the metafield. | Example sponsor |
Input Namespace string / Required namespace | Notes Provide a namespace of the metafield. | Example my_fields |
Input Connection connection / Required shopifyConnection | Notes | Example |
Input Metafield Type string / Required type | Notes Provide a type for the metafield. A list of all supported types can be found here: https://shopify.dev/apps/metafields/types | Example single_line_text_field |
Input Value string / Required value | Notes Provide a value for the metafield. | Example MyExample Sponsor |
Input Value Type string / Required valueType | Notes Provide a type for the metafield value. | Example string |
#
Create OrderCreate a new order | key: createOrder
Input | Notes | Example |
---|---|---|
Input Order Data code / Required orderData | Notes JSON data to be sent as the Order payload. | Example
|
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Create ProductCreate a new product | key: createProduct
Input | Notes | Example |
---|---|---|
Input Body HTML string body | Notes Shopify gives you the option to specify a body formatted in html to be displayed along the rest of the product information. | Example <strong>Try our classic fit!</strong> |
Input Values string Key Value List fieldValues | Notes 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. | Example |
Input Image URL string imageUrl | Notes Provide a valid url containing the image for the product. | Example www.myimages.com/product1 |
Input Product Type string / Required productType | Notes Provide a value for the type of product. | Example T-shirt |
Input Connection connection / Required shopifyConnection | Notes | Example |
Input Tags string Value List tags | Notes For each list item, provide a string you would like to tag the product with. | Example Style |
Input Title string / Required title | Notes Provide a value for the title of the product | Example Classic T-shirt |
Input Vendor string / Required vendor | Notes Provide a value for the vendor of the product. | Example Burton inc. |
#
Create Product ImageCreate a new image on an existing product | key: createProductImage
Input | Notes | Example |
---|---|---|
Input File Name string / Required fileName | Notes Provide a name for the file | Example logo.gif |
Input Image Alt string imageAlt | Notes Provide a string of text to be displayed as an alternative if an image cannot be loaded. | Example This is example alt text. |
Input Image Position string imagePosition | Notes Provide a number for the position of the image. For example, providing 1 will set the default image for the product. | Example 1 |
Input Image URL string / Required imageURL | Notes Provide a URL for the image | Example http://example.com/rails_logo.gif |
Input Product string / Required productId | Notes Provide a value for the product Id. This value can either be an Id or a product title. | Example 74020090 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Create VariantCreate a new variant of the provided product | key: createVariant
Input | Notes | Example |
---|---|---|
Input Values string Key Value List fieldValues | Notes 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. | Example |
Input Price string / Required price | Notes Provide the price of the variant. | Example 1.00 |
Input Product string / Required productId | Notes Provide a value for the product Id. This value can either be an Id or a product title. | Example 74020090 |
Input Connection connection / Required shopifyConnection | Notes | Example |
Input SKU string sku | Notes Provide the sku(A stock-keeping unit) for the variant | Example 97802837847 |
Input Variant Title string / Required variantTitle | Notes Provide the variant title in relation to the base product. | Example Yellow |
Input Weight string weight | Notes Provide the weight of the variant (lbs) | Example 24.00 |
#
Create WebhookCreates a webhook for the desired topic in your Shopify store | key: createWebhook
Input | Default | Notes | Example |
---|---|---|---|
Input Post URL string / Required postUrl | Default | Notes Provide a string value for the URL the newly created webhook will post to. You can use this input to configure your Shopify trigger. | Example |
Input Connection connection / Required shopifyConnection | Default | Notes | Example |
Input Webhook Format string / Required webhookFormat | Default json | Notes Provide a string value for the format you would like your webhook to return. | Example |
Input Webhook Topic string / Required webhookTopic | Default | Notes Provide a string value for the topic you would like to point your webhook at. You can chose from the list found in the Shopify docs: https://shopify.dev/docs/api/admin-rest/2023-04/resources/webhook#event-topics | Example products/create |
#
Output Example Payload{ "data": { "webhook": { "id": 1155048997017, "address": "https://hooks.prismatic.io/trigger/EXAMPLE", "topic": "carts/update", "created_at": "2023-02-09T12:18:11-07:00", "updated_at": "2023-02-09T12:18:11-07:00", "format": "json", "fields": [], "metafield_namespaces": [], "api_version": "2022-04", "private_metafield_namespaces": [] } }}
#
Delete CollectDelete the information and metadata of a collect | key: deleteCollect
Input | Notes | Example |
---|---|---|
Input Collect Id string / Required collectId | Notes Provide a unique identifier of a collect | Example r84963704502935 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Delete CustomerDelete an existing customer | key: deleteCustomer
Input | Notes | Example |
---|---|---|
Input Customer string / Required customerId | Notes Provide a value for the unique identifier of the customer. This value can either be an Id, email, or phone number. | Example 028302 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Delete Draft OrderDelete the information and metadata of a Draft Order | key: deleteDraftOrder
Input | Notes | Example |
---|---|---|
Input Draft Order Id string / Required draftOrderId | Notes Provide the unique identifier of the order. This value can either be an Id, orderNumber, orderName, or customer email. | Example #3002 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Delete Instance WebhooksDelete all webhooks related to this instance | key: deleteInstanceWebhooks
Input | Notes |
---|---|
Input Connection connection / Required shopifyConnection | Notes |
#
Delete Inventory LevelsDelete the information and metadata of an Inventory Level | key: deleteInventoryLevels
Input | Notes | Example |
---|---|---|
Input Inventory Level Id string / Required levelId | Notes Provide a unique identifier of a Inventory Level | Example r84963704502935 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Delete MetafieldDelete the information and metadata of a metafield enabled on your platform | key: deleteMetafield
Input | Notes | Example |
---|---|---|
Input MetaField string / Required metaFieldId | Notes Provide a unique identifier of a metaField. This value can either be an Id, key, value, or description. | Example r84963704502935 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Delete OrderDelete an existing order by Id | key: deleteOrder
Input | Notes | Example |
---|---|---|
Input Order string / Required orderId | Notes Provide the unique identifier of the order. This value can either be an Id, orderNumber, orderName, or customer email. | Example #3002 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Delete ProductDelete an existing product | key: deleteProduct
Input | Notes | Example |
---|---|---|
Input Product string / Required productId | Notes Provide a value for the product Id. This value can either be an Id or a product title. | Example 74020090 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Delete Product ImageDelete the information and metadata of a product image connected to your platform | key: deleteProductImage
Input | Notes | Example |
---|---|---|
Input Image Id string / Required imageId | Notes Provide a unique identifier of a product image | Example r84963704502935 |
Input Product string / Required productId | Notes Provide a value for the product Id. This value can either be an Id or a product title. | Example 74020090 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Delete VariantDelete an existing variant by Id | key: deleteVariant
Input | Notes | Example |
---|---|---|
Input Product string / Required productId | Notes Provide a value for the product Id. This value can either be an Id or a product title. | Example 74020090 |
Input Connection connection / Required shopifyConnection | Notes | Example |
Input Product Variant string / Required variantId | Notes Provide the unique identifier of the product variant. This value can either be an Id or a product variant title. | Example |
#
Delete WebhookDelete a webhook by ID | key: deleteWebhook
Input | Notes |
---|---|
Input Connection connection / Required shopifyConnection | Notes |
Input Webhook ID string / Required webhookId | Notes The ID of an existing webhook |
#
Output Example Payload{ "data": null}
#
Get CollectGet the information and metadata of a collect | key: getCollect
Input | Notes | Example |
---|---|---|
Input Collect Id string / Required collectId | Notes Provide a unique identifier of a collect | Example r84963704502935 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Get CustomerGet a customers information and metadata by Id | key: getCustomer
Input | Notes | Example |
---|---|---|
Input Customer string / Required customerId | Notes Provide a value for the unique identifier of the customer. This value can either be an Id, email, or phone number. | Example 028302 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Get Draft OrderGet the information and metadata of a Draft Order | key: getDraftOrder
Input | Notes | Example |
---|---|---|
Input Draft Order Id string / Required draftOrderId | Notes Provide the unique identifier of the order. This value can either be an Id, orderNumber, orderName, or customer email. | Example #3002 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Get FulfillmentGet the information and metadata of a fulfillment enabled on your platform | key: getFulfillment
Input | Notes | Example |
---|---|---|
Input Fulfillment Id string / Required fulfillmentId | Notes Provide a unique identifier of a fulfillment | Example r84963704502935 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Get Fulfillment OrderRetrieve a specific fulfillment order | key: getFulfillmentOrder
Input | Notes | Example |
---|---|---|
Input Fulfillment Order ID string / Required fulfillmentOrderId | Notes Provide a unique identifier of a fulfillment order | Example 1046000820 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Get Inventory ItemGet the information and metadata of an Inventory Item enabled on your platform | key: getInventoryItems
Input | Notes | Example |
---|---|---|
Input Inventory Item Id string / Required itemId | Notes Provide a unique identifier of a Inventory Item | Example r84963704502935 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Get Inventory LevelsGet the information and metadata of an Inventory Level | key: getInventoryLevels
Input | Notes | Example |
---|---|---|
Input Inventory Level Id string / Required levelId | Notes Provide a unique identifier of a Inventory Level | Example r84963704502935 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Get LocationGet the information and metadata of a location enabled on your platform | key: getLocations
Input | Notes | Example |
---|---|---|
Input Location string / Required locationId | Notes Provide a unique identifier of a location. This value can either be an Id, city, zip, location name, or province. | Example r84963704502935 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Get MetafieldsGet the information and metadata of a metafield enabled on your platform | key: getMetafield
Input | Notes | Example |
---|---|---|
Input MetaField string / Required metaFieldId | Notes Provide a unique identifier of a metaField. This value can either be an Id, key, value, or description. | Example r84963704502935 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Get OrderGet the information and metadata about an order | key: getOrder
Input | Notes | Example |
---|---|---|
Input Order string / Required orderId | Notes Provide the unique identifier of the order. This value can either be an Id, orderNumber, orderName, or customer email. | Example #3002 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Get ProductGet the information and metadata of a product by Id | key: getProduct
Input | Notes | Example |
---|---|---|
Input Product string / Required productId | Notes Provide a value for the product Id. This value can either be an Id or a product title. | Example 74020090 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Get Product ImageGet the information and metadata of a product image connected to your platform | key: getProductImage
Input | Notes | Example |
---|---|---|
Input Image Id string / Required imageId | Notes Provide a unique identifier of a product image | Example r84963704502935 |
Input Product string / Required productId | Notes Provide a value for the product Id. This value can either be an Id or a product title. | Example 74020090 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Get Shop ConfigurationRetrieve the shop's current configuration | key: getShopConfig
Input | Notes |
---|---|
Input Connection connection / Required shopifyConnection | Notes |
#
Get VariantGet the information or metadata of a variant by Id | key: getVariant
Input | Notes | Example |
---|---|---|
Input Product string / Required productId | Notes Provide a value for the product Id. This value can either be an Id or a product title. | Example 74020090 |
Input Connection connection / Required shopifyConnection | Notes | Example |
Input Product Variant string / Required variantId | Notes Provide the unique identifier of the product variant. This value can either be an Id or a product variant title. | Example |
#
List CollectsList all collects enabled on your platform | key: listCollects
Input | Notes | Example |
---|---|---|
Input Limit string limit | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
Input Page Info string pageInfo | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Product string productId | Notes Provide a productId to filter results. | Example 74020090 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
List CurrenciesList all currencies enabled on your platform | key: listCurrencies
Input | Notes | Example |
---|---|---|
Input Limit string limit | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
Input Page Info string pageInfo | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
List CustomersList all customers connected to your platform | key: listCustomers
Input | Notes | Example |
---|---|---|
Input Limit string limit | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
Input Page Info string pageInfo | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
List Draft OrdersList all draft orders | key: listDraftOrders
Input | Notes | Example |
---|---|---|
Input Limit string limit | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
Input Page Info string pageInfo | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
List Fulfillment OrdersRetrieves a list of fulfillment orders for a specific order. | key: listFulfillmentOrders
Input | Notes | Example |
---|---|---|
Input Order string / Required orderId | Notes Provide the unique identifier of the order. This value can either be an Id, orderNumber, orderName, or customer email. | Example #3002 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
List FulfillmentsList all fulfillments enabled on your platform | key: listFulfillments
Input | Notes | Example |
---|---|---|
Input Limit string limit | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
Input Order string / Required orderId | Notes Provide the unique identifier of the order. This value can either be an Id, orderNumber, orderName, or customer email. | Example #3002 |
Input Page Info string pageInfo | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
List Inventory ItemsList all Inventory Items enabled on your platform | key: listInventoryItems
Input | Notes | Example |
---|---|---|
Input Ids string / Required Value List ids | Notes For each item, provide an id of the inventory item to be returned in the response. | Example 39072856 |
Input Limit string limit | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
Input Page Info string pageInfo | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
List Inventory Levels At LocationList all Inventory Levels | key: listInventoryLevels
Input | Notes | Example |
---|---|---|
Input Limit string limit | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
Input Location string / Required locationId | Notes Provide a unique identifier of a location. This value can either be an Id, city, zip, location name, or province. | Example r84963704502935 |
Input Page Info string pageInfo | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
List LocationsList all locations enabled on your platform | key: listLocations
Input | Notes | Example |
---|---|---|
Input Limit string limit | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
Input Page Info string pageInfo | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
List MetafieldsList all metafields enabled on your platform | key: listMetafields
Input | Notes | Example |
---|---|---|
Input Limit string limit | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
Input Page Info string pageInfo | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
Output Example Payload{ "data": { "data": { "metafields": [ { "id": "example", "namespace": "example", "key": "example", "value": "example", "value_type": "string", "description": "This is an example description.", "owner_id": "example", "created_at": "2022-03-31T21:33:14-07:00", "updated_at": "2022-03-31T21:33:14-07:00", "owner_resource": "shop", "type": "ingle_line_text_field" } ] }, "headers": {} }}
#
List OrdersList all orders | key: listOrders
Input | Notes | Example |
---|---|---|
Input Limit string limit | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
Input Page Info string pageInfo | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
List Product ImagesList all product images connected to your platform | key: listProductImages
Input | Notes | Example |
---|---|---|
Input Product string / Required productId | Notes Provide a value for the product Id. This value can either be an Id or a product title. | Example 74020090 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
List ProductsList all products connected to your platform | key: listProducts
Input | Notes | Example |
---|---|---|
Input Limit string limit | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
Input Page Info string pageInfo | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
List VariantsList all variants connected to the provided product | key: listVariants
Input | Notes | Example |
---|---|---|
Input Limit string limit | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
Input Page Info string pageInfo | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Product string / Required productId | Notes Provide a value for the product Id. This value can either be an Id or a product title. | Example 74020090 |
Input Connection connection / Required shopifyConnection | Notes | Example |
#
List WebhooksList all webhooks or webhooks for this instance | key: listWebhooks
Input | Default | Notes |
---|---|---|
Input Connection connection / Required shopifyConnection | Default | Notes |
Input Show only instance webhooks boolean showOnlyInstanceWebhooks | Default true | Notes Show only webhooks that point to this instance |
#
Output Example Payload{ "data": [ { "id": 1155048997017, "address": "https://hooks.prismatic.io/trigger/EXAMPLE", "topic": "carts/update", "created_at": "2023-02-09T12:18:11-07:00", "updated_at": "2023-02-09T12:18:11-07:00", "format": "json", "fields": [], "metafield_namespaces": [], "api_version": "2022-04", "private_metafield_namespaces": [] }, { "id": 1155049029785, "address": "https://abc-123.ngrok.io/", "topic": "carts/update", "created_at": "2023-02-09T12:19:31-07:00", "updated_at": "2023-02-09T12:19:31-07:00", "format": "json", "fields": [], "metafield_namespaces": [], "api_version": "2022-04", "private_metafield_namespaces": [] } ]}
#
Raw RequestSend Raw Request to Shopify | key: rawRequest
Input | Default | Notes | Example |
---|---|---|---|
Input API Version string / Required apiVersion | Default 2021-07 | Notes Shopify versions its API. See https://shopify.dev/docs/api/release-notes for a list of available versions. | Example |
Input Connection connection / Required connection | Default | Notes | Example |
Input Data string data | Default | Notes The HTTP body payload to send to the URL. | Example {"exampleKey": "Example Data"} |
Input Debug Request boolean debugRequest | Default false | Notes Enabling this flag will log out the current request. | Example |
Input File Data string Key Value List fileData | Default | Notes File Data to be sent as a multipart form upload. | Example [{key: "example.txt", value: "My File Contents"}] |
Input Form Data string Key Value List formData | Default | Notes The Form Data to be sent as a multipart form upload. | Example [{"key": "Example Key", "value": new Buffer("Hello World")}] |
Input Header string Key Value List headers | Default | Notes A list of headers to send with the request. | Example User-Agent: curl/7.64.1 |
Input Max Retry Count string maxRetries | Default 0 | Notes The maximum number of retries to attempt. | Example |
Input Method string / Required method | Default | Notes The HTTP method to use. | Example |
Input Query Parameter string Key Value List queryParams | Default | Notes A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2. | Example |
Input Response Type string / Required responseType | Default json | Notes The type of data you expect in the response. You can request json, text, or binary data. | Example |
Input Retry On All Errors boolean retryAllErrors | Default false | Notes If true, retries on all erroneous responses regardless of type. | Example |
Input Retry Delay (ms) string retryDelayMS | Default 0 | Notes The delay in milliseconds between retries. | Example |
Input Timeout string timeout | Default | Notes The maximum time that a client will await a response to its request | Example 2000 |
Input URL string / Required url | Default | Notes This is the URL to call. | Example /sobjects/Account |
Input Use Exponential Backoff boolean useExponentialBackoff | Default false | Notes Specifies whether to use a pre-defined exponential backoff strategy for retries. | Example |
#
Update CustomerUpdate the information and metadata of an existing customer by Id | key: updateCustomer
Input | Default | Notes | Example |
---|---|---|---|
Input Address List code / Required addressList | Default | Notes Provide a JSON array containing address objects | Example
|
Input Currency Format string currency | Default | Notes Provide a valid currency format | Example USD |
Input Customer string / Required customerId | Default | Notes Provide a value for the unique identifier of the customer. This value can either be an Id, email, or phone number. | Example 028302 |
Input Values string Key Value List fieldValues | Default | Notes 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. | Example |
Input Metafields code metafields | Default | Notes Provide a JSON array containing metadata objects | Example
|
Input Notes string notes | Default | Notes Provide a value for a note on the customer | Example This is an example note. |
Input Phone string phone | Default | Notes Provide a value for the phone number of the customer | Example +18005555454 |
Input Connection connection / Required shopifyConnection | Default | Notes | Example |
Input Tags string Value List tags | Default | Notes For each list item, provide a string you would like to tag the product with. | Example Style |
Input Tax Exempt boolean taxExempt | Default false | Notes Determines if the customer is tax exempt. | Example |
Input Email string updateEmail | Default | Notes Provide a string value for the email of the customer | Example someone@example.com |
Input First Name string updateFirstName | Default | Notes Provide a string value for the first name | Example John |
Input Last Name string updateLastName | Default | Notes Provide a string value for the last name of the customer | Example Doe |
Input Verified Email boolean / Required verifiedEmail | Default false | Notes This flag will enable emails to be sent to the customer. | Example |
#
Update Inventory ItemUpdate the information and metadata of an Inventory Item enabled on your platform | key: updateInventoryItems
Input | Default | Notes | Example |
---|---|---|---|
Input Inventory Item Id string / Required itemId | Default | Notes Provide a unique identifier of a Inventory Item | Example r84963704502935 |
Input Price string price | Default | Notes Provide a new price for the item. | Example 1.00 |
Input Connection connection / Required shopifyConnection | Default | Notes | Example |
Input SKU string sku | Default | Notes Provide the sku(A stock-keeping unit) for the variant | Example 97802837847 |
Input Is Tracked boolean tracked | Default false | Notes This field determines if the item is tracked. | Example |
#
Update MetafieldUpdate an existing metafield in your platform | key: updateMetafield
Input | Notes | Example |
---|---|---|
Input Description string description | Notes Provide a description of the metafield value. | Example string |
Input MetaField string / Required metaFieldId | Notes Provide a unique identifier of a metaField. This value can either be an Id, key, value, or description. | Example r84963704502935 |
Input Connection connection / Required shopifyConnection | Notes | Example |
Input Metafield Type string type | Notes Provide a type for the metafield. A list of all supported types can be found here: https://shopify.dev/apps/metafields/types | Example single_line_text_field |
Input Value string value | Notes Provide a value for the metafield. | Example MyExample Sponsor |
Input Value Type string valueType | Notes Provide a type for the metafield value. | Example string |
#
Update ProductUpdate the information and metadata of an existing product by Id | key: updateProduct
Input | Notes | Example |
---|---|---|
Input Values string Key Value List fieldValues | Notes 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. | Example |
Input Image URL string imageUrl | Notes Provide a valid url containing the image for the product. | Example www.myimages.com/product1 |
Input Product string / Required productId | Notes Provide a value for the product Id. This value can either be an Id or a product title. | Example 74020090 |
Input Product Status string productStatus | Notes Specify if the product is active or in draft. | Example |
Input Connection connection / Required shopifyConnection | Notes | Example |
Input Tags string Value List tags | Notes For each list item, provide a string you would like to tag the product with. | Example Style |
Input Title string / Required title | Notes Provide a value for the title of the product | Example Classic T-shirt |
#
Update VariantUpdate the information and metadata of an existing product variant by Id | key: updateVariant
Input | Notes | Example |
---|---|---|
Input Values string Key Value List fieldValues | Notes 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. | Example |
Input Connection connection / Required shopifyConnection | Notes | Example |
Input SKU string sku | Notes Provide the sku(A stock-keeping unit) for the variant | Example 97802837847 |
Input Price string updatePrice | Notes Provide the price of the variant. | Example 1.00 |
Input Variant Title string updateVariantTitle | Notes Provide the variant title in relation to the base product. | Example Yellow |
Input Product Variant string / Required variantId | Notes Provide the unique identifier of the product variant. This value can either be an Id or a product variant title. | Example |
Input Weight string weight | Notes Provide the weight of the variant (lbs) | Example 24.00 |