Shopify Exporter

📘
The Shopify Bulk API documentation can be accessed here

🚧
Important Note on Data Management

We recommend testing this connector using credentials from a staging environment to ensure data flows as intended. Given that the reports can overwrite existing data or create new entries, please proceed with caution when executing them to prevent any unintended changes.

Set up

To configure the Shopify Exporter connector, ensure you have the following credentials available:

For Shopify Exporter (GraphQL - Token):

Personal Access Token (PAT)
Shop Name: Do not include https:// or .myshopify.com.

Alternatively, for Shopify Exporter (GraphQL - Client):

Client ID
Client Secret
Shop Name: Do not include https:// or .myshopify.com.

Features

Feature	Support	Notes
API reliability	🟢	Reliable

Reports detail

⬇️ Report	🔑 Incremental key	🔑 Primary key	📄 Link to API endpoint
Add tags (Orders)	`N/A`	`N/A`	Tags Add
Remove tags (Orders)	`N/A`	`N/A`	Tags Remove

Source Table Creation

Add or Remove Tags (Orders)

To Add tags or Remove tags on orders, your source table must include two specific columns: the Order ID for the records you wish to update, and a Tags Array containing the strings to be added or removed.

Table Snippet

CREATE OR REPLACE TABLE SHOPIFY_TAGS_DATA (
    id VARCHAR  NOT NULL,
    tags VARCHAR  NOT NULL
);

INSERT INTO SHOPIFY_TAGS_DATA (id, tags)
VALUES 
   ('gid://shopify/Order/5043xxxxx0','["good"]'),
   ('gid://shopify/Order/5043xxxxx1','["active", "ready"]'),
   ('gid://shopify/Order/5043xxxxx2','["ready", "active"]'),
   ('gid://shopify/Order/5043xxxxx3','["progress", "inactive"]'),
   ('gid://shopify/Order/5043xxxxx4','["cancelled"]'),
   ('gid://shopify/Order/5043xxxxx5','["alright", "inactive"]'),
   ('gid://shopify/Order/5043xxxxx6','["cancelled", "inactive", "processed"]'),
   ('gid://shopify/Order/5043xxxxx7','["processed", "inactive"]'),
   ('gid://shopify/Order/5043xxxxx8','["ready", "active"]'),
   ('gid://shopify/Order/5043xxxxx9','["active"]'),
   ('gid://shopify/Order/5043xxxx10','["incomplete"]');

Limitations

📘
Behaviour of exporter (and additional table for logging)
Whenever you run these reports the connector will store the requests in a table in the same schema with the same name as the destination table + _responses
so if you export little_pond.big_fish, it’ll be little_pond.big_fish_responses
The rows will contain the first level of the request map flattened (like url, method, headers, etc) as columns, and then a response and error columns with the response or error that came from that request.
In subsequent runs, the new rows will be appended to that same table.

🚧
Data Size

Each export is restricted to a maximum of 100 MB. Exceeding either of these thresholds may cause the export to fail. For a complete list of constraints, please refer to the Shopify Bulk Operations documentation.