Shopify Migration Guide
Upgrading to 2.1.0
This version implements Shopify GraphQL BULK Operations
to speed up the following streams:
Products
Product Images
Product Variants
- In the
Products
stream, thepublished_scope
property is no longer available. - In the
Products
stream, theimages
property now contains only theid
of the image. Refer to theProduct Images
stream instead. - In the
Products
stream, thevariants
property now contains only theid
of the variant. Refer to theProduct Variants
stream instead. - In the
Products
stream, theposition
property is no longer available. - The
Product Variants
stream now has the cursor fieldupdated_at
instead ofid
. - In the
Product Variants
stream, the date-time fields, such ascreated_at
andupdated_at
, now useUTC
format without a timezone component. - In the
Product Variants
stream, thepresentment_prices.compare_at_price
property has changed from anumber
to anobject of strings
. This field was not populated in theREST API
stream version, but it is correctly covered in the GraphQL stream version. - The
Product Variants
stream'sinventory_policy
andinventory_management
properties now containuppercase string
values, instead oflowercase
. - In the
Product Images
stream, the date-time fields, such ascreated_at
andupdated_at
, now useUTC
format without a timezone component. - In the
Product Images
stream, thevariant_ids
andposition
properties are no longer available. Refer to theProduct variants
stream instead. - Retrieving the
deleted
records forProducts
,Product Images
andProduct Variants
streams are no longer available, due to theGraphQL
limitations.
Action items required for 2.1.0
Refresh Schema
+Reset
is required for this stream after the upgrade from previous version.
Upgrading to 2.0.0
This version implements Shopify GraphQL BULK Operations
to speed up the following streams:
Collections
Customer Address
Discount Codes
Fulfillment Orders
Inventory Items
Inventory Levels
Metafield Collections
Metafield Customers
Metafield Draft_orders
Metafield Locations
Metafield Orders
Metafield Product Images
Metafield Product Variants
Transactions Graphql
(duplicatedTransactions
stream to provide faster fetch)
Increased the performance for the following streams:
Fulfillments
Order Refunds
Product Images
Product Variants
Other bug fixes and improvements, more info: https://github.com/airbytehq/airbyte/pull/32345
Action items required for 2.0.0
-
The
Fulfillments
stream now has the cursor fieldupdated_at
, instead of theid
. -
The
Order Refunds
stream, now has the schemarefund_line_items.line_item.properties
to array ofstrings
, instead ofobject
with properties. -
The
Fulfillment Orders
stream now has thesupported_actions
schema asarray of objects
instead ofarray of strings
. -
The
Collections
stream now requires additional api scoperead_publications
to fetch thepublished_at
field withGraphQL BULK Operations
.- if
API_PASSWORD
is used for authentication:- BEFORE UPDATING to the
2.0.0
: update yourPrivate Developer Application
scopes withread_publications
and save the changes, in your Shopify Account.
- BEFORE UPDATING to the
- if
OAuth2.0
is used for authentication:re-auth
in order to obtain new scope automatically, after the upgrade.
Refresh Schema
+Reset
is 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_method
properties fromOrder
stream, they are no longer supplied. - added
company, confirmation_number, current_total_additional_fees_set, original_total_additional_fees_set, tax_exempt, po_number
properties toOrders
stream - added
total_unsettled_set, payment_id
toTransactions
stream - added
return
property toOrder Refund
stream - added
created_at, updated_at
toFulfillment Order
stream