Skip to content

SAC-32470: document Shopify v3 shipping refunds #1264

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
agzam wants to merge 3 commits into
base: master
Choose a base branch
from
Open

SAC-32470: document Shopify v3 shipping refunds #1264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
730db3e
Document Shopify v3 shipping refunds
agzam Oct 14, 2026
b980670
Pin docs build to supported Ruby
agzam Oct 14, 2026
652c638
Revert "Pin docs build to supported Ruby"
agzam Oct 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
140 changes: 140 additions & 0 deletions _data/taps/schemas/shopify/v3/json/order_refunds.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -992,6 +992,146 @@
}
}
},
"refundShippingLines": {
"type": [
"null",
"array"
],
"items": {
"type": [
"null",
"object"
],
"properties": {
"id": {
"type": [
"null",
"string"
]
},
"subtotalAmountSet": {
"type": [
"null",
"object"
],
"properties": {
"presentmentMoney": {
"type": [
"null",
"object"
],
"properties": {
"amount": {
"type": [
"null",
"string"
],
"format": "singer.decimal"
},
"currencyCode": {
"type": [
"null",
"string"
]
}
}
},
"shopMoney": {
"type": [
"null",
"object"
],
"properties": {
"amount": {
"type": [
"null",
"string"
],
"format": "singer.decimal"
},
"currencyCode": {
"type": [
"null",
"string"
]
}
}
}
}
},
"taxAmountSet": {
"type": [
"null",
"object"
],
"properties": {
"presentmentMoney": {
"type": [
"null",
"object"
],
"properties": {
"amount": {
"type": [
"null",
"string"
],
"format": "singer.decimal"
},
"currencyCode": {
"type": [
"null",
"string"
]
}
}
},
"shopMoney": {
"type": [
"null",
"object"
],
"properties": {
"amount": {
"type": [
"null",
"string"
],
"format": "singer.decimal"
},
"currencyCode": {
"type": [
"null",
"string"
]
}
}
}
}
},
"shippingLine": {
"type": [
"null",
"object"
],
"properties": {
"id": {
"type": [
"null",
"string"
]
},
"title": {
"type": [
"null",
"string"
]
}
}
}
}
}
},
"updatedAt": {
"type": [
"null",
Expand Down
6 changes: 3 additions & 3 deletions _data/taps/schemas/shopify/v3/shopify-v3-tables.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,13 +202,13 @@ tables:
primary-key: id
replication-key: updatedAt
- name: order_refunds
description: 'The `{{ table.name }}` table contains info about refunds associated
with orders.
description: 'The `{{ table.name }}` table contains info about refunds and refunded shipping
associated with orders.

'
links:
singer-schema: https://github.com/singer-io/tap-shopify/blob/master/tap_shopify/schemas/order_refunds.json
api-method: https://shopify.dev/docs/admin-api/rest/reference/orders/refund?api[version]=2019-07
api-method: https://shopify.dev/docs/api/admin-graphql/2025-07/objects/Refund
table-details:
replication-method: Key-based Incremental
primary-key: id
Expand Down
2 changes: 2 additions & 0 deletions _saas-integrations/shopify/v3/shopify-v3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,8 @@ replication-sections:
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 {{ integration.display_name }} 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 {{ integration.display_name }} API quota.

The `order_refunds` table includes `refundShippingLines`, which contains each refund's shipping refund amounts and associated shipping line. The field is available in tap-shopify 3.14.0 and later. Select it and reset the `order_refunds` table to backfill shipping refunds for existing orders.


# -------------------------- #
Expand Down
Loading