Schema Change: Field deprecations/sunsetting by fivetran-avinash · Pull Request #155 · fivetran/dbt_shopify

fivetran-avinash · 2026-04-27T19:29:32Z

PR Overview

Package version introduced in this PR:

1.8.0

This PR addresses the following Issue/Feature(s):

GA-1019139

Summary of changes:

Deprecated/sunsetted fields no longer used in Shopify connector

Submission Checklist

SHOPIFY-SPECIFIC: If you added a field to any model with metafields, did you increase the relevant column count in the downstream_model_column_count macro?
Alignment meeting with the reviewer (if needed)
- Timeline and validation requirements discussed
Provide validation details:
- Validation Steps: Check for unintentional effects (e.g., add/run consistency & integrity tests)
- Testing Instructions: Confirm the change addresses the issue(s)
- Focus Areas: Complex logic or queries that need extra attention
Merge any relevant open PRs into this PR

Changelog

Draft changelog for PR
Final changelog for release review

fivetran-savage · 2026-04-28T22:28:37Z

+| ------------- | ----------- | --- | --- | ----- |
+| `shopify__order_lines` | Removed columns | `variant_fulfillment_service`<br>`variant_grams`<br>`variant_weight`<br>`variant_weight_unit`<br>`variant_option_1`<br>`variant_option_2`<br>`variant_option_3` | | Completes deprecation of `product_variant` source, [which was removed in earlier Shopify connector updates](https://fivetran.com/docs/connectors/applications/shopify/changelog#january2025). |
+| `shopify__inventory_levels` | Removed columns | `variant_fulfillment_service`<br>`variant_inventory_management`<br>`variant_grams`<br>`variant_weight`<br>`variant_weight_unit`<br>`variant_option_1`<br>`variant_option_2`<br>`variant_option_3` | | Columns sourced from deprecated `product_variant` source, [removed in earlier Shopify connector updates](https://fivetran.com/docs/connectors/applications/shopify/changelog#january2025). |
+| `shopify__daily_shop`<br>`shopify_gql__daily_shop` | Data changes | Order metrics may be inflated | Order metrics now correctly calculated | Soft-deleted staging shop records filtered out, which previously could incorrectly inflate metrics. |


Suggested change

| `shopify__daily_shop`<br>`shopify_gql__daily_shop` | Data changes | Order metrics may be inflated | Order metrics now correctly calculated | Soft-deleted staging shop records filtered out, which previously could incorrectly inflate metrics. |

| `shopify__daily_shop`<br>`shopify_gql__daily_shop` | Data changes | Order metrics may be inflated | Order metrics now correctly calculated | Soft-deleted staging shop records are now filtered out, which previously could have incorrectly inflated metrics. |

fivetran-savage · 2026-04-28T22:31:15Z

+
+## Documentation
+- Adds deprecation notes to fields no longer supported by the connector. These fields now return null and will be removed in a future release.
+


Should there be an under the hood entry about adjusting the horizontal integrity test?

I'd say no, as we are trying to tighten up our changelogs to be more customer-focused and the customer won't really have interest in what our internal tests are.

fivetran-savage · 2026-04-28T22:54:59Z

+| `shopify__order_lines` | Removed columns | `variant_fulfillment_service`<br>`variant_grams`<br>`variant_weight`<br>`variant_weight_unit`<br>`variant_option_1`<br>`variant_option_2`<br>`variant_option_3` | | Completes deprecation of `product_variant` source, [which was removed in earlier Shopify connector updates](https://fivetran.com/docs/connectors/applications/shopify/changelog#january2025). |
+| `shopify__inventory_levels` | Removed columns | `variant_fulfillment_service`<br>`variant_inventory_management`<br>`variant_grams`<br>`variant_weight`<br>`variant_weight_unit`<br>`variant_option_1`<br>`variant_option_2`<br>`variant_option_3` | | Columns sourced from deprecated `product_variant` source, [removed in earlier Shopify connector updates](https://fivetran.com/docs/connectors/applications/shopify/changelog#january2025). |
+| `shopify__daily_shop`<br>`shopify_gql__daily_shop` | Data changes | Order metrics may be inflated | Order metrics now correctly calculated | Soft-deleted staging shop records filtered out, which previously could incorrectly inflate metrics. |
+


Add deprecated columns to table.

Good callout! Adding that in.

fivetran-savage · 2026-04-28T23:13:08Z

+            description: (DEPRECATED) The number of times that the redeem code has been used. This field now returns null following a connector update and will be removed in a future release.
          - name: code
            description: The redeemable code that a customer can enter at checkout (e.g., `SUMMER20`).
          - name: created_by_description


Neither the body_html or published_scope field from the stg_shopify_gql__product model is documented in the yml, but they should probably be added and then documented as being deprecated. Same goes for pre_tax_price and pre_tax_price_set from the stg_shopify_gql__order_line model, inventory_quantity_management, inventory_quantity_adjustment, and presentment_prices fields from the stg_shopify_gql__product_variant model, and the cost field from the stg_shopify_gql__inventory_item.sql model.

I think this is ok as is? These fields were only present into the REST models and never brought into the GraphQL models, so we don't need to add deprecation documentation as they aren't currently present anywhere in the GraphQL macro/staging flow.

Macros (present in REST, not in GraphQL)
https://github.com/fivetran/dbt_shopify/blob/main/macros/staging/get_order_line_columns.sql#L40
https://github.com/fivetran/dbt_shopify/blob/main/macros/staging/get_product_variant_columns.sql#L44
https://github.com/fivetran/dbt_shopify/blob/main/macros/staging/get_inventory_item_columns.sql#L35

Models (present in REST, not in GraphQL)
https://github.com/fivetran/dbt_shopify/blob/main/models/graphql/staging/stg_shopify_gql__order_line.sql
https://github.com/fivetran/dbt_shopify/blob/main/models/graphql/staging/stg_shopify_gql__product_variant.sql
https://github.com/fivetran/dbt_shopify/blob/main/models/graphql/staging/stg_shopify_gql__inventory_item.sql

Ah, did not realize that!

fivetran-savage · 2026-04-28T23:16:32Z

+        description: (DEPRECATED) The number of times that the redeem code has been used. This field now returns null following a connector update and will be removed in a future release.
      - name: code
        description: The redeemable code that a customer can enter at checkout (e.g., `SUMMER20`).
      - name: created_by_description


Same general comment as in src.yml, there appear to be several fields on the to-be-deprecated list that were never documented in the first place.

See the src yml comment.

fivetran-savage

LGTM!

fivetran-catfritz · 2026-04-29T20:01:38Z

+## Feature Updates
+- Applied removal (or deprecation) of equivalent fields above to the upstream staging models. 


I would just remove this since there is no new information.

Suggested change

## Feature Updates

- Applied removal (or deprecation) of equivalent fields above to the upstream staging models.

fivetran-catfritz · 2026-04-29T20:03:39Z

+
+| Data Model(s) | Change type | Old | New | Notes |
+| ------------- | ----------- | --- | --- | ----- |
+| `shopify__order_lines` | Removed columns | `variant_fulfillment_service`<br>`variant_grams`<br>`variant_weight`<br>`variant_weight_unit`<br>`variant_option_1`<br>`variant_option_2`<br>`variant_option_3` | | [Completes removal of deprecated fields from January updates](https://fivetran.com/docs/connectors/applications/shopify/changelog#january2025). |


Do we want to standardize on “remove” or “sunset”? The PR title uses “sunset,” and that’s what we’ve used in other packages, so I’d lean toward “sunset” for consistency--but open to thoughts. Maybe post in the team channel if you want to discuss.

Good call, let's use sunset, it's the more appropriate term in this case.

…ps://github.com/fivetran/dbt_shopify into schema-change/field-deprecations-and-sunsetting

Schema Change: Field deprecations/sunsetting

a870f91

fivetran-avinash self-assigned this Apr 27, 2026

fivetran-avinash marked this pull request as ready for review April 27, 2026 20:08

fivetran-avinash added 4 commits April 28, 2026 09:27

yml update

cd778b4

dbt_project.yml

11cb9fb

Shop filter deleted records out

7fdd118

Changelog

d19eb8c

fivetran-savage reviewed Apr 28, 2026

View reviewed changes

fivetran-avinash added 2 commits April 28, 2026 16:58

Deprecation changelog updates

fe7ee9a

changelog updates

7d7a246

fivetran-savage approved these changes Apr 29, 2026

View reviewed changes

fivetran-avinash added the docs:ready Triggers the docs generator workflow. label Apr 29, 2026

Generate dbt docs via GitHub Actions

a527b9b

fivetran-catfritz reviewed Apr 29, 2026

View reviewed changes

fivetran-avinash added 2 commits April 29, 2026 13:08

Release review

663bdc5

Merge branch 'schema-change/field-deprecations-and-sunsetting' of htt…

a05770b

…ps://github.com/fivetran/dbt_shopify into schema-change/field-deprecations-and-sunsetting

fivetran-catfritz approved these changes Apr 29, 2026

View reviewed changes

fivetran-avinash added docs:ready Triggers the docs generator workflow. and removed docs:ready Triggers the docs generator workflow. labels Apr 29, 2026

Generate dbt docs via GitHub Actions

799c427

fivetran-avinash merged commit d768d54 into main Apr 29, 2026
8 of 10 checks passed

	\| `shopify__daily_shop`<br>`shopify_gql__daily_shop` \| Data changes \| Order metrics may be inflated \| Order metrics now correctly calculated \| Soft-deleted staging shop records filtered out, which previously could incorrectly inflate metrics. \|
	\| `shopify__daily_shop`<br>`shopify_gql__daily_shop` \| Data changes \| Order metrics may be inflated \| Order metrics now correctly calculated \| Soft-deleted staging shop records are now filtered out, which previously could have incorrectly inflated metrics. \|


		## Documentation
		- Adds deprecation notes to fields no longer supported by the connector. These fields now return null and will be removed in a future release.

		## Feature Updates
		- Applied removal (or deprecation) of equivalent fields above to the upstream staging models.

Conversation

fivetran-avinash commented Apr 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Overview

Submission Checklist

Changelog

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fivetran-savage left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

fivetran-avinash commented Apr 27, 2026 •

edited

Loading