Skip to content

Enhance Shopify order queries with complete order data including line items #17611

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

Jump to bottom
Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Enhance Shopify order queries with complete order data including line items #17611

wants to merge 4 commits into from

Conversation

seynadio
Copy link

@seynadio seynadio commented Jul 14, 2025 •
edited by coderabbitai bot
Loading

Summary

  • Updated GET_ORDER query to include comprehensive order information including complete line items with product and variant details, shipping and billing addresses, fulfillment tracking information, payment transactions and refunds, tax lines and discount allocations, and all financial breakdowns
  • Updated LIST_ORDERS query to include line items with product information, order status and fulfillment details, customer and shipping information, and essential financial data
  • Provides complete order data including all items, customer info, shipping details, and fulfillment tracking when retrieving orders

Summary by CodeRabbit

  • New Features

    • Enhanced order and customer details with comprehensive information on line items, addresses, fulfillments, transactions, refunds, and metafields.
    • Order lists now include additional details and improved pagination support.

  • Improvements

    • Expanded data fields offer a more complete view of orders and customer information throughout the app.

  • Chores

    • Version updates across multiple actions and sources for improved maintenance and consistency.
    • Package version incremented to 0.8.1.

@seynadio
Enhance Shopify order queries with complete order data including line…
a403d99 
… items

- Updated GET_ORDER query to include comprehensive order information:
  - Complete line items with product and variant details
  - Shipping and billing addresses
  - Fulfillment tracking information
  - Payment transactions and refunds
  - Tax lines and discount allocations
  - All financial breakdowns (subtotal, shipping, tax, discounts)

- Updated LIST_ORDERS query to include:
  - Line items with product information
  - Order status and fulfillment details
  - Customer and shipping information
  - Essential financial data

This provides complete order data including all items, customer info, shipping details, and fulfillment tracking when retrieving orders.
@vercel Vercel
Copy link

vercel bot commented Jul 14, 2025

@seynadio is attempting to deploy a commit to the Pipedreamers Team on Vercel.

A member of the Team first needs to authorize it.

@vercel Vercel
Copy link

vercel bot commented Jul 14, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Jul 18, 2025 6:11pm

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 14, 2025 •
edited
Loading

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The GraphQL queries related to Shopify orders were extensively revised. The SuggestedRefund query was renamed to GetOrder and greatly expanded to retrieve comprehensive order, customer, line item, fulfillment, transaction, and refund details. The LIST_ORDERS query was also broadened to fetch more detailed order and pagination information.

Changes

File(s) Change Summary
components/shopify_developer_app/common/queries.mjs Refactored and renamed the SuggestedRefund query to GetOrder with expanded fields; broadened LIST_ORDERS query for more detailed order, customer, line item, fulfillment, transaction, refund, and pagination data.
components/shopify_developer_app/actions/**/*.mjs Incremented version numbers in multiple action modules without functional changes.
components/shopify_developer_app/sources/**/*.mjs Incremented version numbers in multiple source modules without functional changes.
components/shopify_developer_app/package.json Updated package version from 0.8.0 to 0.8.1.

Possibly related PRs

Poem

In the warren of queries, we dug deep today,
Orders and refunds, in detail they lay.
From names and addresses to taxes and tags,
Our data now sparkles, no info that lags.
With every new field, a hop and a cheer—
The shop’s fuller picture is finally here! 🛒🐇

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@adolfo-pd adolfo-pd added the User submitted Submitted by a user label Jul 14, 2025
@pipedream-component-development
Copy link
Collaborator

Thank you so much for submitting this! We've added it to our backlog to review, and our team has been notified.

@pipedream-component-development
Copy link
Collaborator

Thanks for submitting this PR! When we review PRs, we follow the Pipedream component guidelines. If you're not familiar, here's a quick checklist:

coderabbitai[bot]
coderabbitai bot reviewed Jul 14, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Nitpick comments (2)
components/shopify_developer_app/common/queries.mjs (2)

1-468: Consider performance implications of the expanded query.

The GET_ORDER query now fetches comprehensive order data with multiple levels of nested fields and pagination. This could lead to:

  • Increased response times for orders with many line items, fulfillments, or transactions
  • Higher memory usage and potential timeouts
  • Unnecessary data transfer if all fields aren't always needed

Consider implementing field selection based on specific use cases or creating multiple focused queries for different scenarios.

624-624: Inconsistent line items limit between queries.

The LIST_ORDERS query fetches only 50 line items per order while GET_ORDER fetches 250. This inconsistency might cause confusion. If this is intentional for performance reasons in list views, consider adding a comment to document this decision.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e21d334 and a403d99.

📒 Files selected for processing (1)
  • components/shopify_developer_app/common/queries.mjs (4 hunks)
🔇 Additional comments (2)
components/shopify_developer_app/common/queries.mjs (2)

25-89: Well-structured money amount fields.

The consistent implementation of price sets with both shopMoney and presentmentMoney throughout the queries is excellent. This ensures proper multi-currency support across all monetary values.

Also applies to: 162-193, 284-317, 359-368, 388-397, 413-432, 441-450, 554-593, 633-642

2-2: Update usages for renamed GetOrder query

The GraphQL query has been renamed from SuggestedRefund to GetOrder. There is no $refundLineItems variable—refundLineItems remains a nested field in the query, not a removed parameter.

Our rg search over .js, .ts, and .mjs files found:

  • No occurrences of SuggestedRefund
  • No references to a $refundLineItems variable

Please verify:

  • Any code (including .svelte, .vue, backend services, tests, etc.) importing or invoking the old SuggestedRefund query is updated to GetOrder
  • The new GraphQL variables ($id, $first, $after) are passed correctly where this query is used

@michelle0927 michelle0927 self-requested a review July 18, 2025 17:55
michelle0927
michelle0927 approved these changes Jul 18, 2025
View reviewed changes
Copy link
Collaborator

@michelle0927 michelle0927 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your contribution! Ready for QA!

@michelle0927 michelle0927 moved this from In Review to Ready for QA in Component (Source and Action) Backlog Jul 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@michelle0927 michelle0927 michelle0927 approved these changes

Assignees
No one assigned
Labels
User submitted Submitted by a user
Projects
Component (Source and Action) Backlog
Status: Ready for QA
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@seynadio @pipedream-component-development @michelle0927 @adolfo-pd