Shopify Reader
Note
This adapter is in preview and is available on Striim Developer only. See Striim Developer for more information.
Shopify is an e-commerce platform that allows businesses of all sizes to create, manage, and grow their online stores. It provides a comprehensive suite of tools designed to help merchants sell products both online and in physical locations through various channels.
The Shopify Reader can connect with the Shopify platform and read data from supported objects/tables.
Feature summary
Feature | Supported? | Notes | |
|---|---|---|---|
Objects | Standard objects | ✓ | |
Custom objects | ✓ | ||
Authentication | Basic authentication | Username and password | |
OAuth authentication | ✓ | Manual configuration based | |
Custom authentication methods | Not all methods may be supported | ||
Operations | Automated mode | ✓ | |
Initial load | ✓ | ||
Pull-based incremental load | ✓ | ||
Push-based incremental load | |||
Automated pipeline | |||
Governance | Connection profile | ||
Sherlock AI | |||
Sentinel AI | |||
Schema handling | Initial schema creation | ✓ | Works with supported targets |
Schema evolution | |||
Setup | Wizard template | ||
Flow Designer | ✓ | ||
Striim TQL | ✓ | ||
Runtime | Resilience/recovery | ✓ | Supported only for Incremental load. Recovers the data based on the provided Incremental Load Marker. |
Parallel execution | |||
Metrics | ✓ | Standard metrics |
Supported authentication method
The Shopify Reader supports connecting to Shopify using OAuth authentication by providing an admin access token in the Shopify Reader properties. To obtain the Shopify credentials, you create a custom application in Shopify and request an authorization code at Shopify's authorization URL. After receiving the code from a redirect URL, you exchange the authorization code for an admin access token by providing the code to Shopify’s token endpoint, along with the application's API key, API secret, and redirect URI.
Supported objects
The Shopify Reader supports several different Shopify API versions. The following objects are supported by API version:
API version(s) | Objects |
|---|---|
REST_2024_01 | AbandonedCheckouts |
AbandonedCheckoutsItems | |
ApplicationCharges | |
ApplicationCredit | |
Assets | |
CarrierServices | |
CollectionListings | |
Collects | |
Comments | |
Countries | |
CustomCollections | |
CustomerAddresses | |
Customers | |
DiscountApplications | |
DiscountCodes | |
DraftOrderItemProperties | |
DraftOrderItems | |
DraftOrderItemTaxLines | |
DraftOrders | |
Events | |
FulfillmentEvents | |
FulfillmentOrderLineItems | |
FulfillmentOrders | |
Fulfillments | |
FulfillmentServices | |
GiftCards | |
InventoryItems | |
Locations | |
NoteAttributes | |
OrderDiscountCodes | |
OrderItemDiscountAllocations | |
OrderItemProperties | |
Orders | |
OrdersItems | |
OrderTransactions | |
Payouts | |
PayoutTransactions | |
PayoutTransactionsAdjustmentOrderTransactions | |
PriceRules | |
ProductImages | |
ProductListings | |
ProductOptions | |
Products | |
ProductVariants | |
Provinces | |
RecurringApplicationCharges | |
Redirects | |
RefundAdjustments | |
Refunds | |
RefundItems | |
RefundTransactions | |
Reports | |
ResourceFeedbacks | |
ScriptTags | |
ShippingItemDiscountAllocations | |
ShippingItems | |
ShippingZones | |
Shop | |
SmartCollections | |
TaxItems | |
Themes | |
UsageCharges | |
Users | |
REST_2023_10 REST_2023_07 REST_2023_04 | AbandonedCheckouts |
AbandonedCheckoutsItems | |
ApplicationCharges | |
ApplicationCredit | |
Assets | |
CarrierServices | |
CollectionListings | |
Collects | |
Comments | |
Countries | |
CustomCollections | |
CustomerAddresses | |
Customers | |
DiscountApplications | |
DiscountCodes | |
DraftOrderItemProperties | |
DraftOrderItems | |
DraftOrderItemTaxLines | |
DraftOrders | |
Events | |
FulfillmentEvents | |
FulfillmentOrderLineItems | |
FulfillmentOrders | |
Fulfillments | |
FulfillmentServices | |
GiftCards | |
InventoryItems | |
Locations | |
NoteAttributes | |
OrderDiscountCodes | |
OrderItemDiscountAllocations | |
OrderItemProperties | |
Orders | |
OrdersItems | |
OrderTransactions | |
Payouts | |
PayoutTransactions | |
PriceRules | |
ProductImages | |
ProductListings | |
ProductOptions | |
Products | |
ProductVariants | |
Provinces | |
RecurringApplicationCharges | |
Redirects | |
RefundAdjustments | |
Refunds | |
RefundItems | |
RefundTransactions | |
Reports | |
ResourceFeedbacks | |
ScriptTags | |
ShippingItemDiscountAllocations | |
ShippingItems | |
ShippingZones | |
Shop | |
SmartCollections | |
TaxItems | |
Themes | |
UsageCharges | |
Users | |
GRAPHQL_2024_01 | AppCredits |
AppFeedbacks | |
AppSubscriptionLineItems | |
AppSubscriptions | |
CarrierServices | |
Catalogs | |
CollectionProducts | |
CustomerEvents | |
Customers | |
CustomerSegmentMembers | |
DeliveryProfileLocationGroupCountries | |
DeliveryProfileLocationGroupCountryProvinces | |
DeliveryProfileLocationGroups | |
DeliveryProfileLocationGroupsZones | |
DeliveryProfiles | |
DeliveryProfileUnassignedLocations | |
DiscountEvents | |
DiscountsAutomaticApp | |
DiscountsAutomaticBasic | |
DiscountsAutomaticBxgy | |
DiscountsCodeApp | |
DiscountsCodeBasic | |
DiscountsCodeBxgy | |
DiscountsCodeFreeShipping | |
DraftOrderCustomAttributes | |
DraftOrderEvents | |
DraftOrderLineItemCustomAttributes | |
DraftOrderLineItems | |
DraftOrderLineItemTaxLines | |
DraftOrders | |
DraftOrderTaxLines | |
FulfillmentEvents | |
FulfillmentOrderLineItems | |
FulfillmentOrderLocationsForMoveAvailableLineItems | |
FulfillmentOrderLocationsForMoveUnavailableLineItems | |
FulfillmentOrderLocationsForMove | |
FulfillmentOrders | |
Fulfillments | |
FulfillmentServices | |
FulfillmentTrackingInfo | |
GiftCards | |
InventoryItemCountryHarmonizedSystemCodes | |
InventoryItems | |
Locations | |
MetaobjectDefinitions | |
MetaObjects | |
OrderAdditionalFees | |
OrderAgreementAdditionalFeeSales | |
OrderAgreementAdjustmentSales | |
OrderAgreementDutySales | |
OrderAgreementGiftCardSales | |
OrderAgreementProductSales | |
OrderAgreements | |
OrderAgreementShippingLineSales | |
OrderAgreementTipSales | |
OrderAgreementUnknownSales | |
OrderCustomAttributes | |
OrderDiscountApplications | |
OrderEditAgreementAdditionalFeeSales | |
OrderEditAgreementAdjustmentSales | |
OrderEditAgreementDutySales | |
OrderEditAgreementGiftCardSales | |
OrderEditAgreementProductSales | |
OrderEditAgreements | |
OrderEditAgreementShippingLineSales | |
OrderEditAgreementTipSales | |
OrderEditAgreementUnknownSales | |
OrderEvents | |
OrderLineItemCustomAttributes | |
OrderLineItemDiscountAllocations | |
OrderLineItemDuties | |
OrderLineItems | |
OrderNonFulfillableLineItemDuties | |
OrderNonFulfillableLineItems | |
OrderRefundAgreementAdditionalFeeSales | |
OrderRefundAgreementAdjustmentSales | |
OrderRefundAgreementDutySales | |
OrderRefundAgreementGiftCardSales | |
OrderRefundAgreementProductSales | |
OrderRefundAgreements | |
OrderRefundAgreementShippingLineSales | |
OrderRefundAgreementTipSales | |
OrderRefundAgreementUnknownSales | |
Orders | |
OrderTaxLines | |
OrderTransactions | |
PriceListPrices | |
PriceLists | |
ProductMediaImages | |
ProductOptions | |
Products | |
ProductVariants | |
PublicationCollections | |
PublicationProducts | |
Publications | |
RefundDuties | |
RefundLineItemDuties | |
RefundLineItems | |
Refunds | |
RefundTransactionFees | |
RefundTransactions | |
ReturnLineItems | |
Returns | |
ScriptTags | |
SegmentFilterParameters | |
SegmentFilters | |
Segments | |
SellingPlanGroups | |
SellingPlanGroupSellingPlans | |
Shop | |
ShopifyPaymentsAccount | |
ShopifyPaymentsAccountBalance | |
ShopifyPaymentsAccountBalanceTransactionAdjustmentsOrders | |
ShopifyPaymentsAccountBalanceTransactions | |
ShopifyPaymentsAccountBankAccounts | |
ShopifyPaymentsAccountDisputes | |
ShopifyPaymentsAccountPayouts | |
ShopifyPaymentsAccountPermittedVerificationDocuments | |
ShopifyPaymentsAccountVerifications | |
StorefrontAccessTokens | |
TenderTransactions | |
GRAPHQL_2023_10 GRAPHQL_2023_07 | AppCredits |
AppFeedbacks | |
AppSubscriptionLineItems | |
AppSubscriptions | |
CarrierServices | |
Catalogs | |
CollectionProducts | |
CustomerEvents | |
Customers | |
CustomerSegmentMembers | |
DeliveryProfileLocationGroupCountries | |
DeliveryProfileLocationGroupCountryProvinces | |
DeliveryProfileLocationGroups | |
DeliveryProfileLocationGroupsZones | |
DeliveryProfiles | |
DeliveryProfileUnassignedLocations | |
DiscountEvents | |
DiscountsAutomaticApp | |
DiscountsAutomaticBasic | |
DiscountsAutomaticBxgy | |
DiscountsCodeApp | |
DiscountsCodeBasic | |
DiscountsCodeBxgy | |
DiscountsCodeFreeShipping | |
DraftOrderCustomAttributes | |
DraftOrderEvents | |
DraftOrderLineItemCustomAttributes | |
DraftOrderLineItems | |
DraftOrderLineItemTaxLines | |
DraftOrders | |
DraftOrderTaxLines | |
FulfillmentEvents | |
FulfillmentOrderLineItems | |
FulfillmentOrderLocationsForMove | |
FulfillmentOrders | |
Fulfillments | |
FulfillmentServices | |
FulfillmentTrackingInfo | |
GiftCards | |
InventoryItemCountryHarmonizedSystemCodes | |
InventoryItems | |
Locations | |
MetaobjectDefinitions | |
MetaObjects | |
OrderAdditionalFees | |
OrderAgreementAdditionalFeeSales | |
OrderAgreementAdjustmentSales | |
OrderAgreementDutySales | |
OrderAgreementGiftCardSales | |
OrderAgreementProductSales | |
OrderAgreements | |
OrderAgreementShippingLineSales | |
OrderAgreementTipSales | |
OrderAgreementUnknownSales | |
OrderCustomAttributes | |
OrderDiscountApplications | |
OrderEditAgreementAdditionalFeeSales | |
OrderEditAgreementAdjustmentSales | |
OrderEditAgreementDutySales | |
OrderEditAgreementGiftCardSales | |
OrderEditAgreementProductSales | |
OrderEditAgreements | |
OrderEditAgreementShippingLineSales | |
OrderEditAgreementTipSales | |
OrderEditAgreementUnknownSales | |
OrderEvents | |
OrderLineItemCustomAttributes | |
OrderLineItemDiscountAllocations | |
OrderLineItemDuties | |
OrderLineItems | |
OrderNonFulfillableLineItemDuties | |
OrderNonFulfillableLineItems | |
OrderRefundAgreementAdditionalFeeSales | |
OrderRefundAgreementAdjustmentSales | |
OrderRefundAgreementDutySales | |
OrderRefundAgreementGiftCardSales | |
OrderRefundAgreementProductSales | |
OrderRefundAgreements | |
OrderRefundAgreementShippingLineSales | |
OrderRefundAgreementTipSales | |
OrderRefundAgreementUnknownSales | |
Orders | |
OrderTaxLines | |
OrderTransactions | |
PriceListPrices | |
PriceLists | |
ProductImages | |
ProductOptions | |
Products | |
ProductVariants | |
PublicationCollections | |
PublicationProducts | |
Publications | |
RefundDuties | |
RefundLineItemDuties | |
RefundLineItems | |
Refunds | |
RefundTransactionFees | |
RefundTransactions | |
ReturnLineItems | |
Returns | |
ScriptTags | |
SegmentFilterParameters | |
SegmentFilters | |
Segments | |
SellingPlanGroups | |
SellingPlanGroupSellingPlans | |
Shop | |
ShopifyPaymentsAccount | |
ShopifyPaymentsAccountBalance | |
ShopifyPaymentsAccountBankAccounts | |
ShopifyPaymentsAccountDisputes | |
ShopifyPaymentsAccountPayouts | |
ShopifyPaymentsAccountPermittedVerificationDocuments | |
ShopifyPaymentsAccountVerifications | |
StorefrontAccessTokens | |
TenderTransactions | |
GRAPHQL_2023_04 | AppCredits |
AppFeedbacks | |
AppSubscriptionLineItems | |
AppSubscriptions | |
CarrierServices | |
Catalogs | |
CollectionProducts | |
CustomerEvents | |
Customers | |
CustomerSegmentMembers | |
DeliveryProfileLocationGroupCountries | |
DeliveryProfileLocationGroupCountryProvinces | |
DeliveryProfileLocationGroups | |
DeliveryProfileLocationGroupsZones | |
DeliveryProfiles | |
DeliveryProfileUnassignedLocations | |
DiscountEvents | |
DiscountsAutomaticApp | |
DiscountsAutomaticBasic | |
DiscountsAutomaticBxgy | |
DiscountsCodeApp | |
DiscountsCodeBasic | |
DiscountsCodeBxgy | |
DiscountsCodeFreeShipping | |
DraftOrderCustomAttributes | |
DraftOrderEvents | |
DraftOrderLineItemCustomAttributes | |
DraftOrderLineItems | |
DraftOrderLineItemTaxLines | |
DraftOrders | |
DraftOrderTaxLines | |
FulfillmentEvents | |
FulfillmentOrders | |
Fulfillments | |
FulfillmentServices | |
FulfillmentTrackingInfo | |
GiftCards | |
InventoryItemCountryHarmonizedSystemCodes | |
InventoryItems | |
Locations | |
MetaobjectDefinitions | |
MetaObjects | |
OrderAdditionalFees | |
OrderAgreementAdditionalFeeSales | |
OrderAgreementAdjustmentSales | |
OrderAgreementDutySales | |
OrderAgreementGiftCardSales | |
OrderAgreementProductSales | |
OrderAgreements | |
OrderAgreementShippingLineSales | |
OrderAgreementTipSales | |
OrderAgreementUnknownSales | |
OrderCustomAttributes | |
OrderDiscountApplications | |
OrderEditAgreementAdditionalFeeSales | |
OrderEditAgreementAdjustmentSales | |
OrderEditAgreementDutySales | |
OrderEditAgreementGiftCardSales | |
OrderEditAgreementProductSales | |
OrderEditAgreements | |
OrderEditAgreementShippingLineSales | |
OrderEditAgreementTipSales | |
OrderEditAgreementUnknownSales | |
OrderEvents | |
OrderLineItemCustomAttributes | |
OrderLineItemDiscountAllocations | |
OrderLineItemDuties | |
OrderLineItems | |
OrderNonFulfillableLineItemDuties | |
OrderNonFulfillableLineItems | |
OrderRefundAgreementAdditionalFeeSales | |
OrderRefundAgreementAdjustmentSales | |
OrderRefundAgreementDutySales | |
OrderRefundAgreementGiftCardSales | |
OrderRefundAgreementProductSales | |
OrderRefundAgreements | |
OrderRefundAgreementShippingLineSales | |
OrderRefundAgreementTipSales | |
OrderRefundAgreementUnknownSales | |
Orders | |
OrderTaxLines | |
OrderTransactions | |
PriceLists | |
ProductImages | |
ProductOptions | |
Products | |
ProductVariants | |
PublicationCollections | |
PublicationProducts | |
Publications | |
RefundDuties | |
RefundLineItemDuties | |
RefundLineItems | |
Refunds | |
RefundTransactionFees | |
RefundTransactions | |
ReturnLineItems | |
Returns | |
ScriptTags | |
SegmentFilterParameters | |
SegmentFilters | |
Segments | |
SellingPlanGroups | |
SellingPlanGroupSellingPlans | |
Shop | |
ShopifyPaymentsAccount | |
ShopifyPaymentsAccountBalance | |
ShopifyPaymentsAccountBankAccounts | |
ShopifyPaymentsAccountDisputes | |
ShopifyPaymentsAccountPayouts | |
ShopifyPaymentsAccountPermittedVerificationDocuments | |
ShopifyPaymentsAccountVerifications | |
StorefrontAccessTokens | |
TenderTransactions |
Shopify Reader properties
Property | Type | Default value | Notes |
|---|---|---|---|
Admin access token | Password | Access token to access the Shopify platform. | |
API version | Select list (Enum) | Valid values are:
| |
Connection pool size | Integer | 20 | Specifies the maximum number of active connections. |
Connection profile name | String | Used when Use Connection Profile is set to true. Select the Shopify Connection Profile from the list | |
Exclude tables | String | A list of tables excluded from read operations. Typically used to create a list of exceptions when the Tables property includes wildcards. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors. | |
Incremental load marker | String | The incremental load marker is a unique incremental column in each object used for incremental load. When no marker is specified, tables are resynced at each polling interval. Specify the name of the column that contains the start position value. This column must meet the following criteria:
| |
Migrate schema | Boolean | False | Only available in Initial Load or Automated mode. Set to |
Mode | Select list:
| Automated | Automated mode applies incremental updates to objects that support incremental load and performs full resyncs for objects that do not support incremental load. |
Polling interval | Integer | 5m | Specifies an interval as an integer followed by a unit. Supported units are days ( |
Refresh token | Password | An OAuth 2.0 refresh token.Use the value generated while creating the token. | |
ShopURL | String | The full URL of the Shopify Shop. For example | |
Start Position | String | %=-1 | Value of the incremental load marker that defines the initial reading position. |
Tables | String | A semicolon-delimited (;) list of objects to read from the source. Supports the | |
Thread pool count | Integer | 10 | The number of parallel running threads. The default value of zero specifies single-threaded operation. When the value of the thread pool counter is higher than the connection pool size, large data ingestion operations can cause the app to halt. Since best performance is achieved when using one thread for each table being synced, increasing the size of the connection pool to match the number of threads in use is a performance best practice. |
Use connection profile | Boolean | False | Set to True to use a connection profile instead of specifying the connection properties here. See Using connection profiles. |
Limitations
The following are limitations of the Shopify Reader:
Shopify Reader does not support DELETE events currently.
Objects whose time of last update cannot be determined by Striim are duplicated in the target at every polling interval. Typically this occurs when an object does not have an updatedAt field.