Overview
Configuration is provided for establishing connections with Shopify using the service GraphQL Admin API. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this QS, we will show you step-by-step how to create a connection to a Shopify GraphQL Admin API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection Managers tab and select New Connection. Then "Add SSIS Connection Manager" popup window opens, scroll down and select "Connection managers for REST Connection" then click Add.
Step 2. From the Configuration drop down menu select Shopify GraphQL.
Step 3. Provide values for server and password. In SchemaCachingEnabled specify whether to use a local caching of the GraphQL schema. Use True for optimal performance.
Step 4. Test your connection by clicking Test Connection button.
Step 5. Click on OK button.
Congratulations! You have successfully created a connection to a Shopify GraphQL Admin API using COZYROC's REST Connection Manager.
Configuration
Base URL address: https://[shop].myshopify.com/admin/api/2024-10/graphql.json.
- Token
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- Password: Required. Specify your private app Admin API password.
The following request parameters will be automatically processed during the authentication process:
-
X-Shopify-Access-Token:
{{=connection.user.Password}}
Documentation: https://shopify.dev/tutorials/authenticate-a-private-app-with-shopify-admin.
- [Read] action
-
Endpoint URL address:
/.
The result is extracted from:{{=utils.ensureArray(response.data)}}.
The action uses POST method.The action has the following user-defined parameters:
- query: Required. Query statement that will be sent to the GraphQL server.
- variables: Format should be a valid JSON e.g. { "myVar": "myVarValue" }. Optional.
The following request parameters will be automatically processed:
-
application/json:
{{=GraphQL.createCustomQuery(resource, parameters)}}
- [External]
-
The external fields list is extracted from:
{{=GraphQL.getCustomQueryFields(parameters.query)}}.
- [Create] action
-
Endpoint URL address:
/.
The action uses POST method.The action has the following user-defined parameters:
- mutation: Required. Mutation statement that will be sent to the GraphQL server.
- variables: Required. Format should be a valid JSON e.g. { "myVar": "myVarValue" }.
The following request parameters will be automatically processed:
-
application/json:
{{=GraphQL.createCustomMutation(resource, parameters, item)}}
- [External]
-
The external fields list is extracted from:
{{=GraphQL.getCustomMutationFields(parameters)}}.
- [Read] action
-
The result is extracted from:{{=utils.ensureArray(response.data[resource.name])}}.
- [External]
-
The external fields list is extracted from:
{{=GraphQL.getOperationFields(resource.external)}}.
The external resource list is extracted from: {{=GraphQL.getEntrypointMetadataCombined()}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/.
The action uses POST method.The action has the following user-defined parameters:
- operation: Required. Select the operation name.
The following request parameters will be automatically processed:
-
application/json:
{{=GraphQL.createQuery(resource, parameters, 'read')}}
- [Create] action
-
Endpoint URL address:
/.
The action uses POST method.The action has the following user-defined parameters:
- operation: Required. Select the operation name.
The following request parameters will be automatically processed:
-
application/json:
{{=GraphQL.createMutation(resource, parameters, item, 'create')}}
- [Update] action
-
Endpoint URL address:
/.
The action uses POST method.The action has the following user-defined parameters:
- operation: Required. Select the operation name.
The following request parameters will be automatically processed:
-
application/json:
{{=GraphQL.createMutation(resource, parameters, item, 'update')}}
- [Upsert] action
-
Endpoint URL address:
/.
The action uses POST method.The action has the following user-defined parameters:
- operation: Required. Select the operation name.
The following request parameters will be automatically processed:
-
application/json:
{{=GraphQL.createMutation(resource, parameters, item, 'upsert')}}
- [Delete] action
-
Endpoint URL address:
/.
The action uses POST method.The action has the following user-defined parameters:
- operation: Required. Select the operation name.
The following request parameters will be automatically processed:
-
application/json:
{{=GraphQL.createMutation(resource, parameters, item, 'delete')}}
- ShortText
Data type: DT_WSTR ( length 256 )
- LongText
Data type: DT_WSTR ( length 1024 )
- LargeText
Data type: DT_NTEXT
- Int
Data type: DT_I4
- Float
Data type: DT_I8
- Bool
Data type: DT_BOOL
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
Knowledge Base
What's New
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.