Shopify Migration Guide
Upgrading to 2.0.0
This version implements Shopify GraphQL BULK Operations to speed up the following streams:
CollectionsCustomer AddressDiscount CodesFulfillment OrdersInventory ItemsInventory LevelsMetafield CollectionsMetafield CustomersMetafield Draft_ordersMetafield LocationsMetafield OrdersMetafield Product ImagesMetafield Product VariantsTransactions Graphql(duplicatedTransactionsstream to provide faster fetch)
Increased the performance for the following streams:
FulfillmentsOrder RefundsProduct ImagesProduct Variants
Other bug fixes and improvements, more info: https://github.com/airbytehq/airbyte/pull/32345
Action items required for 2.0.0
-
The
Fulfillmentsstream now has the cursor fieldupdated_at, instead of theid. -
The
Order Refundsstream, now has the schemarefund_line_items.line_item.propertiesto array ofstrings, instead ofobjectwith properties. -
The
Fulfillment Ordersstream now has thesupported_actionsschema asarray of objectsinstead ofarray of strings. -
The
Collectionsstream now requires additional api scoperead_publicationsto fetch thepublished_atfield withGraphQL BULK Operations.- if
API_PASSWORDis used for authentication:- BEFORE UPDATING to the
2.0.0: update yourPrivate Developer Applicationscopes withread_publicationsand save the changes, in your Shopify Account.
- BEFORE UPDATING to the
- if
OAuth2.0is used for authentication:re-authin order to obtain new scope automatically, after the upgrade.
Refresh Schema+Resetis required for these streams after the upgrade from previous version.
- if
Upgrading to 1.0.0
This version uses Shopify API version 2023-07 which brings changes to the following streams:
- removed
gateway, payment_details, processing_methodproperties fromOrderstream, they are no longer supplied. - added
company, confirmation_number, current_total_additional_fees_set, original_total_additional_fees_set, tax_exempt, po_numberproperties toOrdersstream - added
total_unsettled_set, payment_idtoTransactionsstream - added
returnproperty toOrder Refundstream - added
created_at, updated_attoFulfillment Orderstream
Action items required for 1.0.0
- The
resetandfull-refreshforOrdersstream is required after upgrading to this version.