Shopify Connector
Manage customers, products, and orders in your Shopify platform
Connections
Admin API Access Token
Authenticate requests to Shopify using an access token.
Input | Comments | Default |
---|---|---|
Admin API Access Token | Generate from the 'API credentials' tab of a private Shopify app that you own | |
Host | The domain of your Shopify platform, without the https:// | YOUR-SHOPIFY-DOMAIN.myshopify.com |
OAuth 2.0
Authenticate requests to Shopify using values obtained from the Developer Console. Allows for using a single domain
input instead of entering separate authorization URL's.
This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.
Input | Comments | Default |
---|---|---|
Shop Name | The Shopify shop name (domain). SHOPIFY-SHOP-NAME.myshopify.com | |
Scopes | A space-delimited set of one or more scopes to get the user's permission to access. A list of all scopes is available here | read_customers read_draft_orders read_fulfillments read_inventory read_orders read_products read_locations write_customers write_draft_orders write_fulfillments write_inventory write_orders write_products write_locations |
API Key | Obtain this by creating an app at Shopify Partners | |
API Secret | Obtain this by creating an app at Shopify Partners |
OAuth 2.0 (Deprecated)
Authenticate requests to Shopify using values obtained from the Developer Console.
This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.
Input | Comments | Default |
---|---|---|
Authorize URL | The OAuth 2.0 Authorization URL for Shopify | https://YOUR-SHOPIFY-DOMAIN.myshopify.com/admin/oauth/authorize |
Token URL | The OAuth 2.0 Token URL for Shopify | https://YOUR-SHOPIFY-DOMAIN.myshopify.com/admin/oauth/access_token |
Scopes | A space-delimited set of one or more scopes to get the user's permission to access. A list of all scopes is available here | read_customers read_draft_orders read_fulfillments read_inventory read_orders read_products read_locations write_customers write_draft_orders write_fulfillments write_inventory write_orders write_products write_locations |
API Key | Obtain this by creating an app at Shopify Partners | |
API Secret | Obtain this by creating an app at Shopify Partners | |
Host | The domain of your Shopify platform, without the https:// | YOUR-SHOPIFY-DOMAIN.myshopify.com |
Triggers
Event Topic Webhook
Set event based webhooks and get notified when these event types are created, updated, or deleted.
Input | Comments | Default |
---|---|---|
Connection | ||
Secret Key | The Shopify app's client secret, viewable from the Partner Dashboard. | |
Webhook Topic | The topic for the webhook. This is the event that will trigger the webhook. |
Event Topic Webhook (Deprecated)
Set event based webhooks and get notified when these event types are created, updated, or deleted. This version of the trigger is being deprecated. Please replace trigger with Event Topic Webhook.
Input | Comments | Default |
---|---|---|
Secret Key | The Shopify app's client secret, viewable from the Partner Dashboard | |
Connection | ||
Event Topic Name | Event that triggers the webhook. |
Webhook
Receive and validate webhook requests from Shopify for webhooks you configure.
Input | Comments | Default |
---|---|---|
Secret Key | The Shopify app's client secret, viewable from the Partner Dashboard |
Actions
Cancel Order
Cancel an existing order.
Input | Comments | Default |
---|---|---|
Connection | ||
Order ID | Provide the unique ID of the order. | |
Reason | The reason for the cancellation. | |
Refund | Whether to refund the amount paid by the customer. | false |
Restock | Whether to restock the inventory committed to the order. | false |
Notify Customer | Whether the customer should be notified of the cancellation. | false |
Staff Note | A staff-facing note about the order cancellation. This is not visible to the customer. |
Close Order
Closes a completed order.
Input | Comments | Default |
---|---|---|
Connection | ||
Order ID | Provide the unique ID of the order. |
Complete Draft Order
Mark a draft order as complete.
Input | Comments | Default |
---|---|---|
Connection | ||
Draft Order Id | Provide a value for the unique ID of the draft order. |
Connect Inventory Item To Location
Connect an existing Inventory Item to an existing Location.
Input | Comments | Default |
---|---|---|
Connection | ||
Location ID | The ID of the location that the inventory level belongs to. | |
Inventory Item Id | Provide a unique ID of a Inventory Item. |
Count Collections
Count all available collections.
Input | Comments | Default |
---|---|---|
Connection |
Count Customers
Retrieve a count of all the customers connected to your platform.
Input | Comments | Default |
---|---|---|
Connection |
Count Draft Orders
Returns a count of all draft orders. Note: This action currently utilizes an unstable version of the Shopify Admin GraphQL API and is subject to change.
Input | Comments | Default |
---|---|---|
Connection | ||
Debug Request | Enabling this flag will log out the current request. | false |
Count Location
Count the number of locations enabled on your platform.
Input | Comments | Default |
---|---|---|
Connection |
Count Orders
Returns a count of all orders.
Input | Comments | Default |
---|---|---|
Connection |
Count Product Images
Count all product images connected to your platform.
Input | Comments | Default |
---|---|---|
Connection | ||
Product ID | Provide a value for the product Id. |
Count Products
Count all Products in your account.
Input | Comments | Default |
---|---|---|
Connection |
Count Variants
Count all product variants.
Input | Comments | Default |
---|---|---|
Connection |
Create Account Activation URL
Create an account activation URL for an existing customer.
Input | Comments | Default |
---|---|---|
Connection | ||
Customer | Provide a value for the unique ID of the customer. |
Create Customer
Create a new customer.
Input | Comments | Default |
---|---|---|
Connection | ||
First Name | Provide a string value for the first name | |
Last Name | Provide a string value for the last name of the customer. | |
Provide a string value for the email of the customer. | ||
Phone | Provide a value for the phone number of the customer. | |
Notes | Provide a value for a note on the customer. | |
Verified Email | This flag will enable emails to be sent to the customer. | false |
Address List | Provide a JSON array containing address objects | |
Values | 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. | |
Currency Format | Provide a valid currency format | |
Tags | For each list item, provide a string you would like to tag the product with. | |
Tax Exempt | Determines if the customer is tax exempt. | false |
Metafields | Provide a JSON array containing metadata objects. |
Create Draft Orders
Create a new draft order.
Input | Comments | Default |
---|---|---|
Connection | ||
Customer | Provide a value for the unique ID of the customer. | |
Line items | Provide a JSON array containing line item objects. | |
Use Customer Address | This flag determines if the order will use the customers default address. | true |
Note | Provide a value for the note on the draft order. | |
Tax Exempt | Whether or not taxes are exempt for the draft order. | false |
Tags | Provide a list of tags for the draft order. | |
Additional Fields | Additional fields that might not be covered by the standard inputs. This is a JSON object. |
Create Fulfillment Service
Create a fulfillment service.
Input | Comments | Default |
---|---|---|
Connection | ||
Fulfillment Service Name | The name of the fulfillment service. | |
Callback URL | The callback URL that the fulfillment service has registered for request. | |
Inventory Management | Whether the fulfillment services tracks product inventory and provides updates to Shopify. | false |
Tracking Support | Whether the fulfillment service supports tracking numbers for packages. | false |
Create Order
Create a new order.
Input | Comments | Default |
---|---|---|
Connection | ||
Order Data | JSON data to be sent as the Order payload. |
Create Product
Create a new product.
Input | Comments | Default |
---|---|---|
Connection | ||
Title | Provide a string value for the title of the product. | |
Description HTML | Provide an HTML string for the description of the product. | |
Product Type | Provide a value for the type of product. | |
Vendor | Provide a value for the vendor of the product. | |
Product Status | Specify the status of the product. | |
Image URL | Provide a URL for the image of the product. | |
Image Alt Text | Provide the alt text for the image of the product. | |
Tags | Provide a list of tags for the product. | |
Additional Fields | Additional fields that might not be covered by the standard inputs. This is a JSON object. |
Create Product Image
Create a new image on an existing product.
Input | Comments | Default |
---|---|---|
Connection | ||
Product ID | Provide a value for the product Id. | |
Image URL | Provide the URL of the image. | |
Image Alt Text | Provide the alt text for the image. |
Create Variant
Create a new variant of the provided product.
Input | Comments | Default |
---|---|---|
Connection | ||
Product ID | Provide a value for the product Id. | |
Variant | Provide a JSON object containing the variant data. |
Create Webhook
Creates a webhook for the desired topic in your Shopify store.
Input | Comments | Default |
---|---|---|
Connection | ||
Webhook Topic | 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 | |
Post URL | Provide a string value for the URL the newly created webhook will post to. You can use this input to configure your Shopify trigger. | |
Webhook Format | Provide a string value for the format you would like your webhook to return. | json |
Delete Collection
Delete a collection by ID.
Input | Comments | Default |
---|---|---|
Connection | ||
Collection ID | Provide a unique ID of a collection. |
Delete Customer
Delete an existing customer.
Input | Comments | Default |
---|---|---|
Connection | ||
Customer | Provide a value for the unique ID of the customer. |
Delete Draft Order
Delete the information and metadata of a Draft Order.
Input | Comments | Default |
---|---|---|
Connection | ||
Draft Order Id | Provide a value for the unique ID of the draft order. |
Delete Fulfillment Service
Deletes an existing fulfillment service.
Input | Comments | Default |
---|---|---|
Connection | ||
Fulfillment Service ID | Provide the unique ID of the fulfillment service. |
Delete Instance Webhooks
Delete all webhooks related to this instance.
Input | Comments | Default |
---|---|---|
Connection |
Delete Inventory Levels
Delete the information and metadata of an Inventory Level.
Input | Comments | Default |
---|---|---|
Connection | ||
Inventory Level Id | Provide a unique ID of an Inventory Level. |
Delete Metafield
Delete a resource metafield. Note: This action currently utilizes an unstable version of the Shopify Admin GraphQL API and is subject to change.
Input | Comments | Default |
---|---|---|
Connection | ||
Key | Provide the key of the metafield to delete. | |
Owner ID | Provide the owner ID of the metafield to delete. | |
Namespace | Provide the namespace of the metafield to delete. |
Delete Order
Delete an existing order by Id.
Input | Comments | Default |
---|---|---|
Connection | ||
Order ID | Provide the unique ID of the order. |
Delete Product
Delete an existing product.
Input | Comments | Default |
---|---|---|
Connection | ||
Product ID | Provide a value for the product Id. |
Delete Product Image
Delete the information and metadata of a product image connected to your platform.
Input | Comments | Default |
---|---|---|
Connection | ||
Product ID | Provide a value for the product Id. | |
Image ID | Provide a unique ID of a product image. |
Delete Variant
Delete an existing variant by Id.
Input | Comments | Default |
---|---|---|
Connection | ||
Product ID | Provide a value for the product Id. | |
Variant ID | Provide a unique ID of a variant. |
Delete Webhook
Delete a webhook by ID.
Input | Comments | Default |
---|---|---|
Connection | ||
Webhook ID | The ID of an existing webhook |
Get Collection
Get a collection by Id.
Input | Comments | Default |
---|---|---|
Connection | ||
Collection ID | Provide a unique ID of a collection. |
Get Customer
Get a customers information and metadata by Id.
Input | Comments | Default |
---|---|---|
Customer | Provide a value for the unique ID of the customer. | |
Connection |
Get Draft Order
Get the information and metadata of a Draft Order.
Input | Comments | Default |
---|---|---|
Connection | ||
Draft Order Id | Provide a value for the unique ID of the draft order. |
Get Fulfillment
Get the information and metadata of a fulfillment enabled on your platform.
Input | Comments | Default |
---|---|---|
Connection | ||
Fulfillment Id | Provide a unique ID of a fulfillment. |
Get Fulfillment Order
Retrieve a specific fulfillment order.
Input | Comments | Default |
---|---|---|
Connection | ||
Fulfillment Order ID | Provide a unique ID of a fulfillment order |
Get Fulfillment Service
Retrieve a fulfillment service enabled on your platform by its ID.
Input | Comments | Default |
---|---|---|
Connection | ||
Fulfillment Service ID | Provide the unique ID of the fulfillment service. |
Get Inventory Item
Get the information and metadata of an Inventory Item enabled on your platform.
Input | Comments | Default |
---|---|---|
Inventory Item Id | Provide a unique ID of a Inventory Item. | |
Connection |
Get Inventory Levels
Get the information and metadata of an Inventory Level.
Input | Comments | Default |
---|---|---|
Connection | ||
Inventory Level Id | Provide a unique ID of an Inventory Level. | |
Debug Request | Enabling this flag will log out the current request. | false |
Get Location
Get the information and metadata of a location enabled on your platform.
Input | Comments | Default |
---|---|---|
Connection | ||
Location ID | The ID of the location that the inventory level belongs to. |
Get Order
Get the information and metadata about an order.
Input | Comments | Default |
---|---|---|
Connection | ||
Order ID | Provide the unique ID of the order. |
Get Order (Deprecated)
Get the information and metadata about an order. This version of the action is being deprecated. Please replace action with Get Order.
Input | Comments | Default |
---|---|---|
Order ID | Provide the unique ID of the order. | |
Connection |
Get Product
Get the information and metadata of a product by Id.
Input | Comments | Default |
---|---|---|
Product ID | Provide a value for the product Id. | |
Connection |
Get Product Image
Get the information and metadata of a product image connected to your platform.
Input | Comments | Default |
---|---|---|
Connection | ||
Product ID | Provide a value for the product Id. | |
Image ID | Provide a unique ID of a product image. Use only the ID number. |
Get Shop Configuration
Retrieve the shop's current configuration.
Input | Comments | Default |
---|---|---|
Connection |
Get Variant
Get the information or metadata of a variant by Id.
Input | Comments | Default |
---|---|---|
Connection | ||
Variant ID | Provide a unique ID of a variant. |
List Collections
List all collections enabled on your platform.
Input | Comments | Default |
---|---|---|
Connection | ||
Limit | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 250. To get more than 250 results, turn the 'Fetch All' toggle ON. | 50 |
Fetch All | API is limited to 250 records per page max, turn this ON to get all data from all pages. When turned ON, the 'Limit' and 'Page Offset Cursor' inputs are ignored. | false |
Page Offset Cursor | Provide a cursor to offset the results. This is used to get the next page of results. | |
Debug Request | Enabling this flag will log out the current request. | false |
List Currencies
List all currencies enabled on your platform.
Input | Comments | Default |
---|---|---|
Connection | ||
Limit | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 250. To get more than 250 results, turn the 'Fetch All' toggle ON. | 50 |
Fetch All | API is limited to 250 records per page max, turn this ON to get all data from all pages. When turned ON, the 'Limit' and 'Page Offset Cursor' inputs are ignored. | false |
Page Offset Cursor | Provide a cursor to offset the results. This is used to get the next page of results. |
List Customers
List all customers connected to your platform.
Input | Comments | Default |
---|---|---|
Get All Data | API is limited to 250 records per page max, turn this on to get all data from all pages. When turned on, the limit input will be ignored. | false |
Limit | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 250. If not provided, the default limit is 50. To get more than 250 results, turn the 'Get All Data' toggle on. | 50 |
Page Offset Token | Provide the page offset token for the given object's results. This is a unique ID used to access a certain page of results. | |
Connection |
List Draft Orders
List all draft orders.
Input | Comments | Default |
---|---|---|
Get All Data | API is limited to 250 records per page max, turn this on to get all data from all pages. When turned on, the limit input will be ignored. | false |
Limit | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 250. If not provided, the default limit is 50. To get more than 250 results, turn the 'Get All Data' toggle on. | 50 |
Page Offset Token | Provide the page offset token for the given object's results. This is a unique ID used to access a certain page of results. | |
Connection |
List Fulfillment Orders
Retrieves a list of fulfillment orders for a specific order.
Input | Comments | Default |
---|---|---|
Connection | ||
Order ID | Provide the unique ID of the order. |
List Fulfillments
List all fulfillments enabled on your platform.
Input | Comments | Default |
---|---|---|
Order ID | Provide the unique ID of the order. | |
Get All Data | API is limited to 250 records per page max, turn this on to get all data from all pages. When turned on, the limit input will be ignored. | false |
Limit | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 250. If not provided, the default limit is 50. To get more than 250 results, turn the 'Get All Data' toggle on. | 50 |
Page Offset Token | Provide the page offset token for the given object's results. This is a unique ID used to access a certain page of results. | |
Connection |
List Fulfillment Services
List all fulfillment services enabled on your platform.
Input | Comments | Default |
---|---|---|
Connection |
List Inventory Items
List all Inventory Items enabled on your platform.
Input | Comments | Default |
---|---|---|
Connection | ||
Query | The query to filter the inventory items. | |
Fetch All | API is limited to 250 records per page max, turn this ON to get all data from all pages. When turned ON, the 'Limit' and 'Page Offset Cursor' inputs are ignored. | false |
Limit | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 250. To get more than 250 results, turn the 'Fetch All' toggle ON. | 50 |
Page Offset Cursor | Provide a cursor to offset the results. This is used to get the next page of results. |
List Inventory Levels At Location
List all Inventory Levels.
Input | Comments | Default |
---|---|---|
Connection | ||
Location ID | The ID of the location that the inventory level belongs to. | |
Fetch All | API is limited to 250 records per page max, turn this ON to get all data from all pages. When turned ON, the 'Limit' and 'Page Offset Cursor' inputs are ignored. | false |
Limit | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 250. To get more than 250 results, turn the 'Fetch All' toggle ON. | 50 |
Page Offset Cursor | Provide a cursor to offset the results. This is used to get the next page of results. |
List Locations
List all locations enabled on your platform.
Input | Comments | Default |
---|---|---|
Connection | ||
Limit | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 250. To get more than 250 results, turn the 'Fetch All' toggle ON. | 50 |
Fetch All | API is limited to 250 records per page max, turn this ON to get all data from all pages. When turned ON, the 'Limit' and 'Page Offset Cursor' inputs are ignored. | false |
Page Offset Cursor | Provide a cursor to offset the results. This is used to get the next page of results. |
List Metafields
List resource metafields. Note: This action currently utilizes an unstable version of the Shopify Admin GraphQL API and is subject to change.
Input | Comments | Default |
---|---|---|
Connection | ||
Resource | Provide a unique ID of a resource. | |
Limit | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 250. To get more than 250 results, turn the 'Fetch All' toggle ON. | 50 |
Fetch All | API is limited to 250 records per page max, turn this ON to get all data from all pages. When turned ON, the 'Limit' and 'Page Offset Cursor' inputs are ignored. | false |
Page Offset Cursor | Provide a cursor to offset the results. This is used to get the next page of results. |
List Orders
List all orders.
Input | Comments | Default |
---|---|---|
Connection | ||
Query | The query to filter the orders. | |
Fetch All | API is limited to 250 records per page max, turn this ON to get all data from all pages. When turned ON, the 'Limit' and 'Page Offset Cursor' inputs are ignored. | false |
Limit | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 250. To get more than 250 results, turn the 'Fetch All' toggle ON. | 50 |
Page Offset Cursor | Provide a cursor to offset the results. This is used to get the next page of results. |
List Orders (Deprecated)
List all orders. This version of the action is being deprecated. Please replace action with List Orders.
Input | Comments | Default |
---|---|---|
Connection | ||
Get All Data | API is limited to 250 records per page max, turn this on to get all data from all pages. When turned on, the limit input will be ignored. | false |
Page Offset Token | Provide the page offset token for the given object's results. This is a unique ID used to access a certain page of results. | |
Limit | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 250. If not provided, the default limit is 50. To get more than 250 results, turn the 'Get All Data' toggle on. | 50 |
Attribution App ID | Show orders attributed to a certain app, specified by the app ID. | |
Created At Max | Show orders created at or before date. ISO 8601 format like 2021-10-01 or 2021-10-01T00:00:00-04:00 for exact time. | |
Created At Min | Show orders created at or after date. ISO 8601 format like 2021-10-01 or 2021-10-01T00:00:00-04:00 for exact time. | |
Fields | Retrieve only certain fields, specified by a comma-separated list of fields names. | |
Financial Status | Filter orders by their financial status. | |
Fulfillment Status | Filter orders by their fulfillment status. | |
Ids | Retrieve only orders specified by a comma-separated list of order IDs. | |
Processed At Max | Show orders imported at or before date. ISO 8601 format like 2021-10-01 or 2021-10-01T00:00:00-04:00 for exact time. | |
Processed At Min | Show orders imported at or after date. ISO 8601 format like 2021-10-01 or 2021-10-01T00:00:00-04:00 for exact time. | |
Since Id | Show orders after the specified ID. | |
Status | Filter orders by their status. | |
Updated At Max | Show orders last updated at or before date. ISO 8601 format like 2021-10-01 or 2021-10-01T00:00:00-04:00 for exact time. | |
Updated At Min | Show orders last updated at or after date. ISO 8601 format like 2021-10-01 or 2021-10-01T00:00:00-04:00 for exact time. |
List Product Images
List all product images connected to your platform.
Input | Comments | Default |
---|---|---|
Product ID | Provide a value for the product Id. | |
Connection |
List Products
List all products connected to your platform.
Input | Comments | Default |
---|---|---|
Limit | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 250. If not provided, the default limit is 50. To get more than 250 results, turn the 'Get All Data' toggle on. | 50 |
Get All Data | API is limited to 250 records per page max, turn this on to get all data from all pages. When turned on, the limit input will be ignored. | false |
Page Offset Token | Provide the page offset token for the given object's results. This is a unique ID used to access a certain page of results. | |
Connection |
List Variants
List all variants connected to the provided product.
Input | Comments | Default |
---|---|---|
Connection | ||
Product ID | Provide a value for the product Id. | |
Fetch All | API is limited to 250 records per page max, turn this ON to get all data from all pages. When turned ON, the 'Limit' and 'Page Offset Cursor' inputs are ignored. | false |
Limit | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 250. To get more than 250 results, turn the 'Fetch All' toggle ON. | 50 |
Page Offset Cursor | Provide a cursor to offset the results. This is used to get the next page of results. |
List Webhooks
List all webhooks or webhooks for this instance.
Input | Comments | Default |
---|---|---|
Connection | ||
Show only instance webhooks | Show only webhooks that point to this instance | true |
Raw Request
Send raw GraphQL request to Shopify.
Input | Comments | Default |
---|---|---|
Connection | ||
API Version | Shopify versions its API. See https://shopify.dev/docs/api/release-notes for a list of available versions. | 2024-10 |
Query or Mutation | GraphQL query or mutation. See Shopify's GraphQL API documentation for examples. Ex: { shop { name } } | |
Variables | Variables to pass to the query or mutation. | |
Variables Object | Variables to pass to the query or mutation. |
Raw Request (Deprecated)
Send raw HTTP request to Shopify. This version of the action uses REST and is being deprecated. Please replace action with the Raw Request utilizing GraphQL.
Input | Comments | Default |
---|---|---|
Connection | ||
URL | Input the path only (/users/current.json), The base URL is already included (https://YOUR-DOMAIN.myshopify.com/admin/api/API-VERSION). For example, to connect to https://YOUR-DOMAIN.myshopify.com/admin/api/API-VERSION/users/current.json, only /users/current.json is entered in this field. | |
Method | The HTTP method to use. | |
Data | The HTTP body payload to send to the URL. | |
Form Data | The Form Data to be sent as a multipart form upload. | |
File Data | File Data to be sent as a multipart form upload. | |
File Data File Names | File names to apply to the file data inputs. Keys must match the file data keys above. | |
Query Parameter | 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. | |
Header | A list of headers to send with the request. | |
Response Type | The type of data you expect in the response. You can request json, text, or binary data. | json |
Timeout | The maximum time that a client will await a response to its request | |
Debug Request | Enabling this flag will log out the current request. | false |
Retry Delay (ms) | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | 0 |
Retry On All Errors | If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. | false |
Max Retry Count | The maximum number of retries to attempt. Specify 0 for no retries. | 0 |
Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. | false |
API Version | Shopify versions its API. See https://shopify.dev/docs/api/release-notes for a list of available versions. | 2024-10 |
Return Headers | Return response headers in the output object. | false |
Set Metafield
Set a resource metafield. Note: This action currently utilizes an unstable version of the Shopify Admin GraphQL API and is subject to change.
Input | Comments | Default |
---|---|---|
Connection | ||
Key | Provide a key for the metafield. | |
Value | Provide a value for the metafield. | |
Owner ID | Provide a unique ID of the owner of the metafield. | |
Type | Provide a type for the metafield. Required when there is no corresponding definition for the given namespace, key, and owner resource type. | |
Namespace | Provide a namespace for the metafield. |
Update Customer
Update the information and metadata of an existing customer by Id.
Input | Comments | Default |
---|---|---|
Connection | ||
Customer | Provide a value for the unique ID of the customer. | |
First Name | Provide a string value for the first name | |
Last Name | Provide a string value for the last name of the customer. | |
Provide a string value for the email of the customer. | ||
Address List | Provide a JSON array containing address objects. | |
Phone | Provide a value for the phone number of the customer. | |
Notes | Provide a value for a note on the customer. | |
Tags | For each list item, provide a string you would like to tag the product with. | |
Tax Exempt | Determines if the customer is tax exempt. | |
Metafields | Provide a JSON array containing metadata objects. | |
Additional Fields | Additional fields that might not be covered by the standard inputs. This is a JSON object. |
Update Fulfillment Service
Modify an existing fulfillment service.
Input | Comments | Default |
---|---|---|
Connection | ||
Fulfillment Service ID | Provide the unique ID of the fulfillment service. | |
Fulfillment Service Name | The name of the fulfillment service. | |
Callback URL | The callback URL that the fulfillment service has registered for request. | |
Inventory Management | Whether the fulfillment services tracks product inventory and provides updates to Shopify. | |
Tracking Support | Whether the fulfillment service supports tracking numbers for packages. | |
Debug Request | Enabling this flag will log out the current request. | false |
Update Inventory Item
Update the information and metadata of an Inventory Item enabled on your platform.
Input | Comments | Default |
---|---|---|
Connection | ||
Inventory Item Id | Provide a unique ID of a Inventory Item. | |
SKU | The SKU (stock keeping unit) of the inventory item. | |
Cost | Unit cost associated with the inventory item, the currency is the shop's default currency. | |
Tracked | Whether the inventory item is tracked. |
Update Product
Update the information and metadata of an existing product by Id.
Input | Comments | Default |
---|---|---|
Connection | ||
Product ID | Provide a value for the product Id. | |
Title | Provide a string value for the title of the product. | |
Description HTML | Provide an HTML string for the description of the product. | |
Product Type | Provide a value for the type of product. | |
Vendor | Provide a value for the vendor of the product. | |
Product Status | Specify the status of the product. | |
Image URL | Provide a URL for the image of the product. | |
Image Alt Text | Provide the alt text for the image of the product. | |
Tags | For each list item, provide a string you would like to tag the product with. | |
Additional Fields | Additional fields that might not be covered by the standard inputs. This is a JSON object. |
Update Variant
Update the information and metadata of an existing product variant by Id.
Input | Comments | Default |
---|---|---|
Connection | ||
Product ID | Provide a value for the product Id. | |
Update Variant | Provide a JSON object containing the variant data to update. |