This integration is powered by Singer's Shopify tap and certified by Stitch. Check out and contribute to the repo on GitHub.
For support, contact Support.
Shopify integration summary
Stitch’s Shopify integration replicates data using the Shopify GraphQL Admin API (v2025-01). Refer to the Schema section for a list of objects available for replication.
Shopify is now powered by GraphQL
We’ve have enhanced the Stitch’s Shopify integration by replacing REST Admin API by the Shopify GraphQL API. This provides:
- More structured and complete data
- Better performance and scalibility
- Access to new fields that are unavailable in REST
What has changed?
The data structure has been reorganized for consistency and clarity. Some fields may look different or appear in new locations. Also, a few fields are deprecated from the Shopify side.
If you need help, you can compare the structures. Refer to Shopify documentation:
Check out our updated Shopify docs for stream-level details and examples.
Shopify feature snapshot
A high-level look at Stitch's Shopify (v3) integration, including release status, useful links, and the features supported in Stitch.
| STITCH | |||
| Release status |
Released on April 1, 2025 |
Supported by | |
| Stitch plan |
Standard |
API availability |
Available |
| Singer GitHub repository | |||
| REPLICATION SETTINGS | |||
| Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
| Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
| DATA SELECTION | |||
| Table selection |
Supported |
Column selection |
Supported |
| Select all |
Supported |
||
| TRANSPARENCY | |||
| Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting Shopify
Shopify setup requirements
To set up Shopify in Stitch, you need:
-
Admin access in Shopify. This is required to allow Stitch to replicate data.
Note: If you’re on a Shopify Plus plan, the permissions required may differ. Store owners can grant users permissions to export orders, draft orders, products, inventory, and customer data. In general, view-level permissions should be sufficient.
Refer to the Shopify Staff permissions documentation for more information.
Step 1: Add Shopify as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Shopify icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch Shopify” would create a schema called
stitch_shopifyin the destination. Note: Schema names cannot be changed after you save the integration.
Step 2: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your Shopify integration. This means that data equal to or newer than this date will be replicated to your data warehouse.
Change this setting if you want to replicate data beyond Shopify’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 3: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
Shopify integrations support the following replication scheduling methods:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Step 4: Authorize Stitch to access Shopify
- Next, you’ll be prompted to sign into your Shopify account. Enter your Shopify credentials.
- Click Log in.
- After the authorization process is successfully completed, you’ll be directed back to Stitch.
- Click All Done.
Step 5: Set objects to replicate
The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.
Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.
For Shopify integrations, you can select:
-
Individual tables and columns
-
All tables and columns
Click the tabs to view instructions for each selection method.
- In the integration’s Tables to Replicate tab, locate a table you want to replicate.
-
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
-
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
- Repeat this process for all the tables and columns you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
- Click into the integration from the Stitch Dashboard page.
-
Click the Tables to Replicate tab.
- In the list of tables, click the box next to the Table Names column.
-
In the menu that displays, click Track all Tables and Fields:
- Click the Finalize Your Selections button at the bottom of the page to save your data selections.
Initial and historical replication jobs
After you finish setting up Shopify, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
Shopify replication
Replicating order refunds
To extract order refund data, Stitch queries every order in your account. If you have the order_refunds table selected for replication, the process can potentially be very slow depending on how many orders and refunds exist in your Shopify account. As tables are extracted one at a time, this could cause extraction to not proceed for days at a time. To ensure timely replication of your other selected tables, consider creating a separate integration for only the order_refunds table.
Note: Creating a separate integration for your order_refunds table may negatively affect your Shopify API quota.
Shopify table reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 3 of this integration.
This is the latest version of the Shopify integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs > customers), while case is maintained in PostgreSQL destinations (CusTomERs > CusTomERs). Refer to the Loading Guide for your destination for more info.
abandoned_checkouts
The abandoned_checkouts table contains info about abandoned checkouts. Shopify considers a checkout to be abandoned when a customer has entered billing and shipping details, but hasn’t completed the purchase.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updatedAt |
| Useful links |
| Join abandoned_checkouts with | on |
|---|---|
| customers |
abandoned_checkouts.customers.id = customers.id abandoned_checkouts.customers.lastOrder.id = customers.lastOrder.id |
| order_refunds |
abandoned_checkouts.customers.lastOrder.id = order_refunds.order.id abandoned_checkouts.lineItems.product.id = order_refunds.refundLineItems.lineItem.product.id |
| orders |
abandoned_checkouts.customers.lastOrder.id = orders.id abandoned_checkouts.lineItems.product.id = orders.lineItems.product.id |
| transactions |
abandoned_checkouts.customers.lastOrder.id = transactions.order.id |
| products |
abandoned_checkouts.lineItems.product.id = products.id |
|
note STRING |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
|
completedAt STRING |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
|
billingAddress OBJECT
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
|
discountCodes ARRAY |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
|
createdAt STRING |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
|
updatedAt
STRING |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
|
taxLines ARRAY
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
|
totalLineItemsPriceSet OBJECT
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
|
id
STRING |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
|
name STRING |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
|
totalTaxSet OBJECT
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
|
shippingAddress OBJECT
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
|
abandonedCheckoutUrl STRING |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
|
totalDiscountSet OBJECT
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
|
taxesIncluded BOOLEAN |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
|
totalDutiesSet OBJECT
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
|
totalPriceSet OBJECT
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
|
lineItems ARRAY
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subtotalPriceSet OBJECT
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
|
customer OBJECT
|
collections
The collections table contains info about the collections.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updatedAt |
| Useful links |
|
id
STRING |
|||||
|
title STRING |
|||||
|
handle STRING |
|||||
|
collectionType STRING |
|||||
|
updatedAt
STRING |
|||||
|
productsCount OBJECT
|
|||||
|
sortOrder STRING |
|||||
|
ruleSet OBJECT
|
|||||
|
seo OBJECT
|
|||||
|
feedback OBJECT
|
|||||
|
products ARRAY |
customers
The customers table contains info about the shop’s customers. This includes their contact details, order history, and email marketing preferences.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updatedAt |
| Useful links |
| Join customers with | on |
|---|---|
| abandoned_checkouts |
customers.id = abandoned_checkouts.customers.id customers.lastOrder.id = abandoned_checkouts.customers.lastOrder.id |
| order_refunds |
customers.lastOrder.id = order_refunds.order.id |
| orders |
customers.lastOrder.id = orders.id |
| transactions |
customers.lastOrder.id = transactions.order.id |
|
STRING |
||||||||||||||||||||
|
multipassIdentifier STRING |
||||||||||||||||||||
|
defaultAddress OBJECT
|
||||||||||||||||||||
|
numberOfOrders STRING |
||||||||||||||||||||
|
state STRING |
||||||||||||||||||||
|
verifiedEmail BOOLEAN |
||||||||||||||||||||
|
firstName STRING |
||||||||||||||||||||
|
updatedAt
STRING |
||||||||||||||||||||
|
note STRING |
||||||||||||||||||||
|
phone STRING |
||||||||||||||||||||
|
addresses ARRAY
|
||||||||||||||||||||
|
lastName STRING |
||||||||||||||||||||
|
tags ARRAY |
||||||||||||||||||||
|
taxExempt BOOLEAN |
||||||||||||||||||||
|
id
STRING |
||||||||||||||||||||
|
createdAt STRING |
||||||||||||||||||||
|
taxExemptions ARRAY |
||||||||||||||||||||
|
emailMarketingConsent OBJECT
|
||||||||||||||||||||
|
smsMarketingConsent OBJECT
|
||||||||||||||||||||
|
validEmailAddress BOOLEAN |
||||||||||||||||||||
|
productSubscriberStatus STRING |
||||||||||||||||||||
|
amountSpent OBJECT
|
||||||||||||||||||||
|
dataSaleOptOut BOOLEAN |
||||||||||||||||||||
|
displayName STRING |
||||||||||||||||||||
|
locale STRING |
||||||||||||||||||||
|
lifetimeDuration STRING |
||||||||||||||||||||
|
lastOrder OBJECT
|
events
The events table contains info about events in the shop.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
createdAt |
| Useful links |
|
id
STRING |
|
createdAt
STRING |
|
action STRING |
|
appTitle STRING |
|
attributeToApp BOOLEAN |
|
attributeToUser BOOLEAN |
|
criticalAlert BOOLEAN |
|
message STRING |
|
subjectId STRING |
|
subjectType STRING |
|
additionalContent STRING |
|
additionalData STRING |
|
arguments ARRAY |
|
hasAdditionalContent BOOLEAN |
|
secondaryMessage STRING |
|
attachments ARRAY |
|
author OBJECT |
|
canDelete BOOLEAN |
|
canEdit BOOLEAN |
|
edited BOOLEAN |
|
rawMessage STRING |
inventory_items
The inventory_items table contains info about items in a shop.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updatedAt |
| Useful links |
|
id
STRING |
||
|
sku STRING |
||
|
createdAt STRING |
||
|
updatedAt
STRING |
||
|
requiresShipping BOOLEAN |
||
|
unitCost OBJECT
|
||
|
countryCodeOfOrigin STRING |
||
|
provinceCodeOfOrigin STRING |
||
|
harmonizedSystemCode STRING |
||
|
tracked BOOLEAN |
||
|
countryHarmonizedSystemCodes ARRAY
|
inventory_levels
The inventory_levels table contains info about quantities of an inventory item for a location.
|
Key-based Incremental |
|
|
Primary Keys |
id |
|
Replication Key |
updatedAt |
| Useful links |
|
id
STRING |
||||
|
canDeactivate BOOLEAN |
||||
|
createdAt STRING |
||||
|
updatedAt
STRING |
||||
|
deactivationAlert STRING |
||||
|
item OBJECT
|
||||
|
location OBJECT
|
||||
|
quantities ARRAY
|
locations
The locations table contains info about .
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
createdAt |
| Useful links |
|
id
STRING |
||||||||||||
|
name STRING |
||||||||||||
|
updatedAt STRING |
||||||||||||
|
createdAt
STRING |
||||||||||||
|
isActive BOOLEAN |
||||||||||||
|
addressVerified BOOLEAN |
||||||||||||
|
deactivatable BOOLEAN |
||||||||||||
|
deactivatedAt STRING |
||||||||||||
|
deletable BOOLEAN |
||||||||||||
|
fulfillsOnlineOrders BOOLEAN |
||||||||||||
|
hasActiveInventory BOOLEAN |
||||||||||||
|
hasUnfulfilledOrders BOOLEAN |
||||||||||||
|
isFulfillmentService BOOLEAN |
||||||||||||
|
legacyResourceId STRING |
||||||||||||
|
shipsInventory BOOLEAN |
||||||||||||
|
address OBJECT
|
||||||||||||
|
localPickupSettingsV2 OBJECT
|
metafields_collections
The metafields_collections table contains info about metafields for collections.
|
Key-based Incremental |
|
|
Primary Keys |
id |
|
Replication Key |
updatedAt |
| Useful links |
|
owner OBJECT
|
|
|
ownerType STRING |
|
|
value_type STRING |
|
|
key STRING |
|
|
createdAt STRING |
|
|
id
STRING |
|
|
namespace STRING |
|
|
description STRING |
|
|
value INTEGER, OBJECT, STRING |
|
|
updatedAt
STRING |
|
|
type STRING |
metafields_customers
The metafields_customers table contains info about metafields for customers.
|
Key-based Incremental |
|
|
Primary Keys |
id |
|
Replication Key |
updatedAt |
| Useful links |
|
owner OBJECT
|
|
|
ownerType STRING |
|
|
value_type STRING |
|
|
key STRING |
|
|
createdAt STRING |
|
|
id
STRING |
|
|
namespace STRING |
|
|
description STRING |
|
|
value INTEGER, OBJECT, STRING |
|
|
updatedAt
STRING |
|
|
type STRING |
metafields_orders
The metafields_orders table contains info about metafields for orders.
|
Key-based Incremental |
|
|
Primary Keys |
id |
|
Replication Key |
updatedAt |
| Useful links |
|
owner OBJECT
|
|
|
ownerType STRING |
|
|
value_type STRING |
|
|
key STRING |
|
|
createdAt STRING |
|
|
id
STRING |
|
|
namespace STRING |
|
|
description STRING |
|
|
value INTEGER, OBJECT, STRING |
|
|
updatedAt
STRING |
|
|
type STRING |
metafields_products
The metafields_products table contains info about metafields for products.
|
Key-based Incremental |
|
|
Primary Keys |
id |
|
Replication Key |
updatedAt |
| Useful links |
|
owner OBJECT
|
|
|
ownerType STRING |
|
|
value_type STRING |
|
|
key STRING |
|
|
createdAt STRING |
|
|
id
STRING |
|
|
namespace STRING |
|
|
description STRING |
|
|
value INTEGER, OBJECT, STRING |
|
|
updatedAt
STRING |
|
|
type STRING |
order_refunds
The order_refunds table contains info about refunds associated with orders.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
createdAt |
| Useful links |
| Join order_refunds with | on |
|---|---|
| abandoned_checkouts |
order_refunds.order.id = abandoned_checkouts.customers.lastOrder.id order_refunds.refundLineItems.lineItem.product.id = abandoned_checkouts.lineItems.product.id |
| customers |
order_refunds.order.id = customers.lastOrder.id |
| orders |
order_refunds.order.id = orders.id order_refunds.refundLineItems.lineItem.product.id = orders.lineItems.product.id |
| transactions |
order_refunds.order.id = transactions.order.id |
| products |
order_refunds.refundLineItems.lineItem.product.id = products.id |
|
id
STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
createdAt
STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
legacyResourceId STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
note STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
order OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
refundLineItems ARRAY
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
orderAdjustments ARRAY
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
updatedAt STRING |
orders
The orders table contains info about a shop’s completed orders.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updatedAt |
| Useful links |
| Join orders with | on |
|---|---|
| abandoned_checkouts |
orders.id = abandoned_checkouts.customers.lastOrder.id orders.lineItems.product.id = abandoned_checkouts.lineItems.product.id |
| customers |
orders.id = customers.lastOrder.id |
| order_refunds |
orders.id = order_refunds.order.id orders.lineItems.product.id = order_refunds.refundLineItems.lineItem.product.id |
| transactions |
orders.id = transactions.order.id |
| products |
orders.lineItems.product.id = products.id |
|
additionalFees ARRAY
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
app OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
billingAddress OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
billingAddressMatchesShippingAddress BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
canMarkAsPaid BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
canNotifyCustomer BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
cancelReason STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
cancellation OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
cancelledAt STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
capturable BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
cartDiscountAmountSet OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
channelInformation OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
clientIp STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
closed BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
closedAt STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
confirmationNumber STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
confirmed BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
createdAt STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
currencyCode STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
currentCartDiscountAmountSet OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
currentShippingPriceSet OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
currentSubtotalLineItemsQuantity INTEGER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
currentSubtotalPriceSet OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
currentTotalAdditionalFeesSet OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
currentTotalDiscountsSet OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
currentTotalDutiesSet OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
currentTotalPriceSet OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
currentTotalTaxSet OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
currentTotalWeight NUMBER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
customer OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
customerJourneySummary OBJECT |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
merchantOfRecordApp OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
customerAcceptsMarketing BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
customerLocale STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
discountCodes ARRAY |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
discountCode STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
displayFinancialStatus STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
displayFulfillmentStatus STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
disputes ARRAY
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
dutiesIncluded BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
edited BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
estimatedTaxes BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
fulfillable BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
fullyPaid BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
hasTimelineComment BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
fulfillmentsCount OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
id
STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
legacyResourceId STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
merchantBusinessEntity OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
name STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
note STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
netPaymentSet OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
originalTotalAdditionalFeesSet OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
originalTotalDutiesSet OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
originalTotalPriceSet OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
paymentGatewayNames ARRAY |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
phone STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
poNumber STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
presentmentCurrencyCode STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
processedAt STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
refundable BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
refundDiscrepancySet OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
registeredSourceUrl STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
requiresShipping BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
restockable BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
returnStatus STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
shippingAddress OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
shopifyProtect OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
sourceIdentifier STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
sourceName STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
statusPageUrl STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subtotalLineItemsQuantity INTEGER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subtotalPriceSet OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
tags ARRAY |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
taxExempt BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
taxLines ARRAY
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
taxesIncluded BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
test BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
totalCapturableSet OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
totalCashRoundingAdjustment OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
totalDiscountsSet OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
totalOutstandingSet OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
totalPriceSet OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
totalReceivedSet OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
totalRefundedSet OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
totalRefundedShippingSet OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
totalShippingPriceSet OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
totalTaxSet OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
totalTipReceivedSet OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
totalWeight NUMBER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
transactionsCount OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
unpaid BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
updatedAt
STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
fulfillments ARRAY
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
lineItems ARRAY
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
shippingLine OBJECT
|
product_variants
The product_variants table contains info about variants that can be added to a product to represent one version of a product with several options.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updatedAt |
| Useful links |
|
id
STRING |
|||||
|
createdAt STRING |
|||||
|
barcode STRING |
|||||
|
availableForSale BOOLEAN |
|||||
|
compareAtPrice STRING |
|||||
|
displayName STRING |
|||||
|
image OBJECT
|
|||||
|
inventoryPolicy STRING |
|||||
|
inventoryQuantity INTEGER |
|||||
|
position INTEGER |
|||||
|
price STRING |
|||||
|
requiresComponents BOOLEAN |
|||||
|
sellableOnlineQuantity INTEGER |
|||||
|
sku STRING |
|||||
|
taxCode STRING |
|||||
|
taxable BOOLEAN |
|||||
|
title STRING |
|||||
|
updatedAt
STRING |
|||||
|
product OBJECT
|
|||||
|
inventoryItem OBJECT
|
products
The products table contains info about a shop’s products.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updatedAt |
| Useful links |
| Join products with | on |
|---|---|
| abandoned_checkouts |
products.id = abandoned_checkouts.lineItems.product.id |
| order_refunds |
products.id = order_refunds.refundLineItems.lineItem.product.id |
| orders |
products.id = orders.lineItems.product.id |
|
status STRING |
||||||||||||||||||||||||
|
publishedAt STRING |
||||||||||||||||||||||||
|
createdAt STRING |
||||||||||||||||||||||||
|
vendor STRING |
||||||||||||||||||||||||
|
updatedAt
STRING |
||||||||||||||||||||||||
|
productType STRING |
||||||||||||||||||||||||
|
tags STRING |
||||||||||||||||||||||||
|
options ARRAY
|
||||||||||||||||||||||||
|
handle STRING |
||||||||||||||||||||||||
|
templateSuffix STRING |
||||||||||||||||||||||||
|
title STRING |
||||||||||||||||||||||||
|
id
STRING |
||||||||||||||||||||||||
|
giftCardTemplateSuffix STRING |
||||||||||||||||||||||||
|
hasOnlyDefaultVariant STRING |
||||||||||||||||||||||||
|
hasOutOfStockVariants BOOLEAN |
||||||||||||||||||||||||
|
hasVariantsThatRequiresComponents BOOLEAN |
||||||||||||||||||||||||
|
isGiftCard BOOLEAN |
||||||||||||||||||||||||
|
description STRING |
||||||||||||||||||||||||
|
descriptionHtml STRING |
||||||||||||||||||||||||
|
category OBJECT
|
||||||||||||||||||||||||
|
featuredMedia OBJECT
|
||||||||||||||||||||||||
|
requiresSellingPlan BOOLEAN |
||||||||||||||||||||||||
|
totalInventory INTEGER |
||||||||||||||||||||||||
|
tracksInventory BOOLEAN |
||||||||||||||||||||||||
|
media ARRAY
|
transactions
The transactions table contains info about transactions.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
createdAt |
| Useful links |
| Join transactions with | on |
|---|---|
| abandoned_checkouts |
transactions.order.id = abandoned_checkouts.customers.lastOrder.id |
| customers |
transactions.order.id = customers.lastOrder.id |
| order_refunds |
transactions.order.id = order_refunds.order.id |
| orders |
transactions.order.id = orders.id |
|
accountNumber STRING |
||||||||||||||
|
amountRoundingSet OBJECT
|
||||||||||||||
|
amountSet OBJECT
|
||||||||||||||
|
authorizationCode STRING |
||||||||||||||
|
authorizationExpiresAt STRING |
||||||||||||||
|
createdAt
STRING |
||||||||||||||
|
errorCode STRING |
||||||||||||||
|
formattedGateway STRING |
||||||||||||||
|
gateway STRING |
||||||||||||||
|
id
STRING |
||||||||||||||
|
kind STRING |
||||||||||||||
|
manualPaymentGateway BOOLEAN |
||||||||||||||
|
maximumRefundableV2 OBJECT |
||||||||||||||
|
multiCapturable BOOLEAN |
||||||||||||||
|
order OBJECT
|
||||||||||||||
|
parentTransaction OBJECT
|
||||||||||||||
|
paymentId STRING |
||||||||||||||
|
processedAt STRING |
||||||||||||||
|
receiptJson STRING |
||||||||||||||
|
settlementCurrency STRING |
||||||||||||||
|
settlementCurrencyRate STRING |
||||||||||||||
|
shopifyPaymentsSet OBJECT
|
||||||||||||||
|
status STRING |
||||||||||||||
|
test BOOLEAN |
||||||||||||||
|
totalUnsettledSet OBJECT
|
||||||||||||||
|
fees ARRAY
|
||||||||||||||
|
manuallyCapturable BOOLEAN |
||||||||||||||
|
paymentDetails OBJECT
|
| Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.