Shopify

Help article for the Shopify node that wraps the Shopify Admin REST API.

Revision History

1.0.0.0 Initial Release.
1.0.0.1 Fixed bug where in-url parameters weren't working as expected.
1.0.0.3 Added support for query string parameters not defined by the vendor samples.
1.0.0.4 Fixed bug where Custom Properties were mutated and could affect subsequent invokes within the same Workflow instance

Properties

Connection

Type: Connection Input
The Connection Property

ShopifyBaseUrl
Type: String
The base URL for your Shopify store. E.g. https://.myshopify.com

XShopifyAccessToken
Type: Password
Used for authentication, see https://help.shopify.com/en/manual/apps/app-types/custom-apps#create-and-install-a-custom-app for instructions on how to generate credentials.

ReturnRestFailureResponses
Type: Boolean
When turned ON - Errors are not expressed as node errors, but are instead expressed inside the response payload.

ExcludeEmptyQueryParameters
Type: Boolean
When turned ON - Any empty custom properties on the node that would usually be expressed as query string parameters are ignored.

AllowCustomQueryParameters
Type: Boolean
When turned ON - Any empty custom properties on the node that do not exist as potential query string parameters on the definition will be added anyway.

OperationId

Type: String Input
Contains the ID of the operation chosen from a Node Sample. This property shouldn't be manually changed.

Description

Type: String Input
A generated description of the operation based on what was available in the Swagger document.

Request

Type: Multiline Text Input
Contains the request payload (usually JSON) that provides the detail of the operation to perform. A sample value for this property is populated when a Node Sample is selected.

ResponseCode

Type: Type: String Output
Contains the response code returned from the API Server. 200 = Success etc.

ResponseHeaders

Type: Multiline Text Output
Contains the response headers as received from the API Server. Response headers can be used to paginate within the Shopify API.

Response

Type: Multiline Text Output
Contains the response payload (usually JSON) as received from the API. Where possible, a sample value of this property is populated when a Node Sample is selected.

Custom Inputs

This Node supports Custom Input Properties and the appropriate properties will be added to the Node when a Node Sample is selected. These Properties are resolved into parameters in the URL that is generated for the request. For example, if the operation will query a customer record, the Swagger document may specify the URL template as /customers/{customerId}. In this case, a Custom Property called customerId will be added to the Node when a "get customer" Node Sample is selected.

Remarks

Using Samples

This Node provides Samples for all supported calls. Samples can be accessed from the Node Samples Pane.